{ "openapi": "3.0.1", "info": { "title": "Power Grid Proximity Screener - Transmission Lines Near Sites", "description": "Electric substation proximity API: for each site (lat/lon), get distance to the nearest substation, transmission line (kV, owner), and power plant, plus density counts and a HIGH/MEDIUM/LOW grid-access tier. Keyless HIFLD data. For data-center, renewable and BESS siting.", "version": "1.0", "x-build-id": "fJ4xZrTI2v7iNipl6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~hifld-grid-proximity-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-hifld-grid-proximity-screener", "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~hifld-grid-proximity-screener/runs": { "post": { "operationId": "runs-sync-malonestar-hifld-grid-proximity-screener", "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~hifld-grid-proximity-screener/run-sync": { "post": { "operationId": "run-sync-malonestar-hifld-grid-proximity-screener", "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", "properties": { "assets": { "title": "Assets (sites to screen)", "type": "array", "description": "Sites to screen for grid access. Each entry is an object { \"lat\": number, \"lon\": number, \"label\": \"optional name\" }. Also accepts \"lat,lon\" strings or [lat, lon] arrays. One dataset row (one billed result) is produced per asset; a bad entry yields an ERROR row and the run continues." }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Radius around each asset to search for transmission lines, substations and power plants, in miles (1-50). Features beyond this distance are ignored. Default 5.", "default": 5 }, "minVoltageKv": { "title": "Minimum line voltage (kV)", "minimum": 1, "maximum": 1200, "type": "integer", "description": "Optional. Only count/consider transmission lines with voltage at or above this many kV (e.g. 115 or 230). Lines with unknown voltage are excluded when set. Does not filter substations or power plants. Leave empty to include all lines." }, "includeSubstations": { "title": "Screen electric substations", "type": "boolean", "description": "Also query the HIFLD Electric Substations layer and report the nearest substation (name, distance in km, max voltage) plus substations within the radius. On by default since v1.1 — set to false to skip substation screening and speed up large batches.", "default": true }, "includePowerPlants": { "title": "Screen power plants", "type": "boolean", "description": "Also query the HIFLD Power Plants layer and report the nearest power plant (name, distance in km, fuel/type, capacity MW) plus power plants within the radius. On by default since v1.1 — set to false to skip power-plant screening and speed up large batches.", "default": true }, "includePlanned": { "title": "Flag non-authoritative planned lines (advanced)", "type": "boolean", "description": "Advanced/opt-in. Also check a HIFLD 'planned transmission line' scratch layer that carries NO owner/voltage/status metadata. It is NOT an authoritative planned-line dataset — the planned_line_nearby flag is a low-confidence 'a planned-line geometry exists nearby' hint only. Default false.", "default": false }, "maxResults": { "title": "Max assets to screen", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of assets processed in one run (1-2000). One result row is emitted (and billed) per asset. Default 500.", "default": 500 } } }, "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 } } } } } } } } } }