{ "openapi": "3.0.1", "info": { "title": "Solar Resource & PVWatts Yield Scorer — Batch Site Screening", "description": "Batch solar resource assessment via NREL PVWatts v8. Lat/lon list in; annual/monthly kWh yield, capacity factor, irradiance, and a solar-worthiness class out. The resource-quality layer for solar, storage, and data-center siting.", "version": "1.0", "x-build-id": "rw1UXi4OAUTHVN7CA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~nrel-pvwatts-solar-resource-scorer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-nrel-pvwatts-solar-resource-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/malonestar~nrel-pvwatts-solar-resource-scorer/runs": { "post": { "operationId": "runs-sync-malonestar-nrel-pvwatts-solar-resource-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/malonestar~nrel-pvwatts-solar-resource-scorer/run-sync": { "post": { "operationId": "run-sync-malonestar-nrel-pvwatts-solar-resource-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": [ "assets" ], "properties": { "assets": { "title": "Sites", "type": "array", "description": "List of sites to score, each { lat, lon, label }. lat/lon are decimal degrees (WGS84); label is a free-text name shown on the output row (e.g. a parcel address or project name). One PVWatts call per site." }, "apiKey": { "title": "NREL developer.nrel.gov API key", "type": "string", "description": "Your free NREL Developer Network key (register in 30 seconds at https://developer.nrel.gov/signup/). The prefilled shared DEMO_KEY works for small runs (~30 req/hr) but is rate-limited across all anonymous users; on HTTP 429 / OVER_RATE_LIMIT the actor emits a partial-results row per remaining site instead of failing the run." }, "systemCapacityKw": { "title": "System capacity (kW DC)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Nameplate DC system size in kW used for the PVWatts simulation. Output kwh_per_kw_year normalizes annual production per kW so sites of different assumed capacity remain comparable.", "default": 4 }, "moduleType": { "title": "Module type", "minimum": 0, "maximum": 2, "type": "integer", "description": "PVWatts module type: 0 = Standard, 1 = Premium, 2 = Thin film. Allowed values: 0, 1, 2.", "default": 0 }, "arrayType": { "title": "Array type", "minimum": 0, "maximum": 4, "type": "integer", "description": "PVWatts array/mounting type: 0 = Fixed - Open Rack, 1 = Fixed - Roof Mounted, 2 = 1-Axis Tracking, 3 = 1-Axis Backtracking, 4 = 2-Axis Tracking. Allowed values: 0, 1, 2, 3, 4.", "default": 1 }, "tilt": { "title": "Array tilt (degrees)", "minimum": 0, "maximum": 90, "type": "integer", "description": "Panel tilt angle from horizontal in degrees (0 = flat, 90 = vertical). 20 degrees is a common default roof pitch.", "default": 20 }, "azimuth": { "title": "Array azimuth (degrees)", "minimum": 0, "maximum": 359, "type": "integer", "description": "Panel azimuth in degrees from north, clockwise (180 = due south, the typical northern-hemisphere optimum).", "default": 180 }, "losses": { "title": "System losses (%)", "minimum": 0, "maximum": 99, "type": "integer", "description": "Overall PVWatts system-loss percentage (soiling, shading, wiring, inverter, etc.). NREL's default assumption is 14%.", "default": 14 } } }, "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 } } } } } } } } } }