{ "openapi": "3.0.1", "info": { "title": "Solar Panel Rooftop Lead Scorer: No-Key PVGIS Google Solar API", "description": "Keyless solar pre-screening with EU JRC PVGIS 5.3: modeled yield, energy ranges, confidence and explainable lead scores for solar installers and solar panel sales. No Google key needed. US addresses and PVGIS-covered coordinates supported. Optional Google Solar API BYOK mode adds rooftop geometry.", "version": "0.2", "x-build-id": "4UnB63UExdm1JMUH9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~solar-rooftop-lead-scorer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-solar-rooftop-lead-scorer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/kamerozkan~solar-rooftop-lead-scorer/runs": { "post": { "operationId": "runs-sync-kamerozkan-solar-rooftop-lead-scorer", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/kamerozkan~solar-rooftop-lead-scorer/run-sync": { "post": { "operationId": "run-sync-kamerozkan-solar-rooftop-lead-scorer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "acceptTerms" ], "properties": { "demoMode": { "title": "Run an illustrative demo", "type": "boolean", "description": "Return one clearly marked sample result without calling any live data provider or charging a property event. A small Actor-start charge may still apply. Turn this off for real keyless or Google analysis.", "default": false }, "providerMode": { "title": "Analysis provider", "enum": [ "OPEN_DATA", "GOOGLE" ], "type": "string", "description": "OPEN_DATA needs no API key and uses PVGIS 5.3 plus transparent assumptions. GOOGLE uses Google Solar Building Insights and requires your key. If omitted in API calls, a googleApiKey supplied in Actor input selects GOOGLE; otherwise OPEN_DATA is used. An environment key alone does not switch modes." }, "googleApiKey": { "title": "Google Maps Platform API key", "type": "string", "description": "Required only in GOOGLE mode. Use a restricted BYOK key from a billing-enabled Google Cloud project with Geocoding API and Solar API enabled. Leave blank in OPEN_DATA mode." }, "acceptTerms": { "title": "Accept Terms and confirm permitted use", "type": "boolean", "description": "I accept the Actor Terms and Privacy Policy, will use property data lawfully for energy-system purposes, will not market to a person without their opt-in, and will follow provider-specific attribution and retention rules. In GOOGLE mode, I will delete Google-derived content by googleContentExpiresAt unless an exception applies.", "default": false }, "addresses": { "title": "Simple property address list", "maxItems": 10000, "type": "array", "description": "Backward-compatible string list. In keyless OPEN_DATA mode, each U.S. address must include street number/name, city, 2-letter state, and 5-digit ZIP. Use Address items below when you can supply roof area or system capacity.", "items": { "type": "string", "minLength": 3 } }, "addressItems": { "title": "Addresses with property details", "maxItems": 10000, "type": "array", "description": "Preferred address input when roof area or proposed system capacity is known. Property-specific capacity evidence allows an OPEN_DATA result to qualify; without it, the address receives a comparison scenario only.", "items": { "type": "object", "properties": { "id": { "title": "ID", "type": "string", "description": "Optional stable identifier copied to sourceId in the output.", "editor": "textfield" }, "address": { "title": "Complete property address", "type": "string", "description": "For keyless U.S. matching, use: street, city, ST ZIP. Example: 350 5th Ave, New York, NY 10118.", "minLength": 10, "editor": "textfield" }, "roofAreaM2": { "title": "Roof area (m²)", "type": "number", "description": "Optional measured or customer-supplied total roof area. Enables a property-specific capacity estimate.", "minimum": 0.1, "maximum": 10000, "editor": "number" }, "systemCapacityKw": { "title": "System capacity (kW)", "type": "number", "description": "Optional known or proposed system capacity. Takes precedence over roof-area capacity assumptions.", "minimum": 0.01, "maximum": 100, "editor": "number" } }, "required": [ "address" ], "additionalProperties": false } }, "coordinates": { "title": "Property coordinates", "maxItems": 10000, "type": "array", "description": "Latitude/longitude pairs in PVGIS-covered land areas. OPEN_DATA uses coordinates directly, subject to PVGIS coverage; GOOGLE mode reverse-geocodes them.", "items": { "type": "object", "properties": { "id": { "title": "ID", "type": "string", "description": "Optional stable identifier copied to sourceId in the output.", "editor": "textfield" }, "latitude": { "title": "Latitude", "type": "number", "description": "Property latitude in decimal degrees.", "minimum": -90, "maximum": 90, "editor": "number" }, "longitude": { "title": "Longitude", "type": "number", "description": "Property longitude in decimal degrees.", "minimum": -180, "maximum": 180, "editor": "number" }, "roofAreaM2": { "title": "Roof area (m²)", "type": "number", "description": "Optional measured or customer-supplied total roof area. Improves the open-data capacity estimate.", "minimum": 0.1, "maximum": 10000, "editor": "number" }, "systemCapacityKw": { "title": "System capacity (kW)", "type": "number", "description": "Optional known or proposed system capacity. Takes precedence over roof-area capacity assumptions.", "minimum": 0.01, "maximum": 100, "editor": "number" } }, "required": [ "latitude", "longitude" ], "additionalProperties": false } }, "inputDatasetId": { "title": "Input dataset", "type": "string", "description": "Read properties from an existing Apify dataset. Rows may contain an address or latitude/longitude fields." }, "addressField": { "title": "Dataset address field", "type": "string", "description": "Field containing the property address in input dataset rows.", "default": "address" }, "latitudeField": { "title": "Dataset latitude field", "type": "string", "description": "Field containing latitude in input dataset rows.", "default": "latitude" }, "longitudeField": { "title": "Dataset longitude field", "type": "string", "description": "Field containing longitude in input dataset rows.", "default": "longitude" }, "idField": { "title": "Dataset ID field", "type": "string", "description": "Optional stable ID copied to sourceId in the output.", "default": "id" }, "roofAreaM2Field": { "title": "Dataset roof-area field", "type": "string", "description": "Optional field containing total roof area in square metres.", "default": "roofAreaM2" }, "systemCapacityKwField": { "title": "Dataset system-capacity field", "type": "string", "description": "Optional field containing known or proposed PV capacity in kW.", "default": "systemCapacityKw" }, "countryCode": { "title": "Expected country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "ISO 3166-1 alpha-2 country. OPEN_DATA keyless address geocoding currently supports US only; coordinates work in most PVGIS-covered land areas, subject to provider coverage. GOOGLE uses this as a forward-geocoding filter.", "default": "US" }, "requiredQuality": { "title": "Minimum imagery quality", "enum": [ "HIGH", "MEDIUM", "BASE" ], "type": "string", "description": "Minimum Google Solar imagery quality. BASE maximizes coverage; HIGH is strictest.", "default": "BASE" }, "defaultSystemCapacityKw": { "title": "Standard comparison system (kW)", "minimum": 0.01, "maximum": 100, "type": "number", "description": "OPEN_DATA fallback when no roof area or system capacity is supplied. The output clearly labels this as a standardized scenario, not measured rooftop capacity.", "default": 5 }, "defaultRoofAreaM2": { "title": "Optional default roof area (m²)", "minimum": 0.1, "maximum": 10000, "type": "number", "description": "Optional shared roof-area assumption for items without their own roofAreaM2. Leave blank to use the standard comparison system." }, "usableRoofFraction": { "title": "Usable roof fraction", "minimum": 0.1, "maximum": 1, "type": "number", "description": "OPEN_DATA fraction of supplied or default roof area assumed usable after setbacks and obstructions. It is an assumption, not imagery analysis.", "default": 0.55 }, "panelPowerWatts": { "title": "Panel power (W)", "minimum": 100, "maximum": 1000, "type": "number", "description": "Panel nameplate power used for open-data capacity estimates.", "default": 440 }, "panelAreaM2": { "title": "Panel area (m²)", "minimum": 0.5, "maximum": 5, "type": "number", "description": "Approximate area per panel used for open-data capacity estimates.", "default": 2 }, "systemLossPercent": { "title": "PV system losses (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Loss value sent to PVGIS for the open-data production model.", "default": 14 }, "pvgisMountingPlace": { "title": "PVGIS mounting model", "enum": [ "free", "building" ], "type": "string", "description": "OPEN_DATA PVGIS thermal mounting assumption. free is a ventilated rack proxy; building models fully integrated modules with no rear airflow. This is a model assumption, not a detected roof property.", "default": "free" }, "pvgisPvTechnology": { "title": "PVGIS module technology", "enum": [ "crystSi2025", "crystSi" ], "type": "string", "description": "OPEN_DATA PVGIS module model. crystSi2025 is the current crystalline-silicon model; crystSi retains the legacy crystalline-silicon model for comparisons.", "default": "crystSi2025" }, "roofTiltDegrees": { "title": "Known roof tilt (degrees)", "minimum": 0, "maximum": 90, "type": "number", "description": "Optional. Provide together with roof azimuth. Otherwise PVGIS optimal orientation is used and clearly marked as an assumption." }, "roofAzimuthDegrees": { "title": "Known roof azimuth (degrees)", "minimum": -180, "maximum": 180, "type": "number", "description": "Optional PVGIS convention: 0=south, -90=east, 90=west. Provide together with roof tilt." }, "energyUncertaintyPercent": { "title": "Screening energy range (±%)", "minimum": 5, "maximum": 50, "type": "number", "description": "Transparent low/high allowance around the modeled open-data annual energy. It is not a statistical guarantee.", "default": 20 }, "gridCarbonIntensityKgPerKwh": { "title": "Grid carbon intensity (kg/kWh)", "minimum": 0, "type": "number", "description": "Optional user assumption for annual avoided-emissions screening." }, "minLeadScore": { "title": "Qualification score", "minimum": 1, "maximum": 100, "type": "integer", "description": "Properties at or above this score are marked qualified.", "default": 65 }, "monthlyElectricBillUsd": { "title": "Monthly electric bill (USD)", "minimum": 0, "type": "number", "description": "Optional GOOGLE-mode input used to select the closest Google financial analysis." }, "annualElectricityUsageKwh": { "title": "Annual electricity use (kWh)", "minimum": 0, "type": "number", "description": "Optional. Used to select a right-sized panel configuration." }, "electricityPricePerKwhUsd": { "title": "Electricity price ($/kWh)", "minimum": 0, "type": "number", "description": "Optional user-supplied energy-price assumption. In OPEN_DATA it estimates gross modeled annual energy value (generation × price), before self-consumption, export rates, fees, degradation, and taxes; it is not guaranteed bill savings. In GOOGLE it is a fallback when provider financial details are unavailable." }, "installationCostPerWattUsd": { "title": "Installed cost ($/W)", "minimum": 0, "type": "number", "description": "Optional user-supplied installed-cost assumption used with the energy-price assumption for a simple pre-screen payback." }, "incentiveRate": { "title": "Upfront incentive rate", "minimum": 0, "maximum": 1, "type": "number", "description": "Optional user-supplied fraction between 0 and 1 deducted from assumed installation cost. No incentive is assumed by default. Example: 0.30 means 30%.", "default": 0 }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard processing cap across direct inputs and dataset rows. This is not a billing cap: set Maximum cost per run in Apify before starting. At the current price, each completed property analysis costs up to $0.04; no-data and error rows are free.", "default": 1000 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Concurrent properties. Keep this within provider quotas. PVGIS publishes a 30 requests/second/IP limit.", "default": 5 }, "requestTimeoutSecs": { "title": "API request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each external provider request.", "default": 30 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }