{ "openapi": "3.0.1", "info": { "title": "Power Outage Alerts by County & Site - US Utilities Data", "description": "Which of your sites are dark? Pulls live US county outages from the DOE/ORNL ODIN feed, matches your sites (lat/lng or county), flags new, worse and restored outages against the history it keeps. Covers participating utilities only, not all US customers.", "version": "1.0", "x-build-id": "FPXdzX9uIQ0dk4D7U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~power-outage-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-power-outage-alerts", "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/that_red_bird~power-outage-alerts/runs": { "post": { "operationId": "runs-sync-that_red_bird-power-outage-alerts", "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/that_red_bird~power-outage-alerts/run-sync": { "post": { "operationId": "run-sync-that_red_bird-power-outage-alerts", "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": { "sites": { "title": "Sites to watch", "type": "array", "description": "JSON list of sites. Each needs a \"name\" and one of: \"lat\" and \"lng\" (point-in-county match), \"fips\" (5-digit county code), or \"state\" plus \"county\" (for example {\"name\":\"Store 12\",\"state\":\"TX\",\"county\":\"Harris\"}). State may be the full name or the 2-letter code.", "default": [ { "name": "Demo site by coordinates (NYC)", "lat": 40.7128, "lng": -74.006 }, { "name": "Demo site by county (Santa Barbara CA)", "state": "CA", "county": "Santa Barbara" } ] }, "maxOutageRecords": { "title": "Max outage records to list", "type": "integer", "description": "How many county/utility outage records to output, largest first. Each is billed as one outage-record event. Set 0 to output only site alerts.", "default": 25 }, "states": { "title": "Only these states (optional)", "type": "array", "description": "Limit the listed outage records to these states (full name or 2-letter code). Site matching always uses the full feed. Leave empty for all states.", "default": [], "items": { "type": "string" } }, "siteAlertMinMeters": { "title": "Site alert threshold (meters affected)", "type": "integer", "description": "A site counts as affected when the outages in its county add up to at least this many meters (customers) out. Counties are large, so this says the area is dark, not that your building is.", "default": 100 }, "escalationPercent": { "title": "Escalation percent", "type": "integer", "description": "An already-affected site raises an ESCALATED alert when the county total grew by at least this percent since the last run, or crossed 1,000 / 10,000 / 50,000 meters.", "default": 50 }, "onlyChanges": { "title": "Alert only on changes", "type": "boolean", "description": "When on, a site that is still affected at about the same level is not re-alerted (and not billed) on later runs. NEW, ESCALATED and RESTORED always alert. Every site still gets a free status row.", "default": true }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "If set, every billed site alert is also POSTed here as JSON. A failing webhook never fails the run.", "default": "" }, "stateStoreName": { "title": "History store name", "type": "string", "description": "Named key-value store that keeps the last county totals and a rolling history between runs. Use a different name per monitoring setup so schedules do not share history.", "default": "power-outage-alerts-state" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }