{ "openapi": "3.0.1", "info": { "title": "UK Storm Overflow & River Pollution Live Monitor", "description": "Near-real-time UK sewage storm-overflow tracker: aggregates every major English water company official live feed, cross-checks active discharges against Environment Agency rainfall data, and flags new discharge starts/stops vs the previous run.", "version": "0.1", "x-build-id": "YoOUVqpiYpdBWCfWB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hllerdgn80~uk-storm-overflow-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hllerdgn80-uk-storm-overflow-monitor", "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/hllerdgn80~uk-storm-overflow-monitor/runs": { "post": { "operationId": "runs-sync-hllerdgn80-uk-storm-overflow-monitor", "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/hllerdgn80~uk-storm-overflow-monitor/run-sync": { "post": { "operationId": "run-sync-hllerdgn80-uk-storm-overflow-monitor", "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": { "lookbackHours": { "title": "Lookback window (hours)", "minimum": 6, "maximum": 168, "type": "integer", "description": "How far back to look for outfalls whose discharge status has changed, across every covered water company's live feed. Wider windows catch discharges that started and stopped between runs.", "default": 48 }, "company": { "title": "Water company filter", "type": "string", "description": "Only return outfalls run by this water company, e.g. \"Thames Water\" or \"Severn Trent Water\". Leave blank to check all nine covered companies." }, "watercourseContains": { "title": "River / watercourse name contains", "type": "string", "description": "Only return outfalls whose receiving watercourse name contains this text, e.g. \"Thames\" or \"Trent\". Case-insensitive, matched against the company's own watercourse name." }, "nearLatitude": { "title": "Near latitude", "type": "number", "description": "Optional: combined with 'Near longitude' and 'Search radius', only return outfalls within that radius of this point (e.g. a specific bathing spot or fishing stretch)." }, "nearLongitude": { "title": "Near longitude", "type": "number", "description": "Optional: paired with 'Near latitude'." }, "nearRadiusKm": { "title": "Search radius around the point (km)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Radius in kilometres used only when 'Near latitude'/'Near longitude' are both set.", "default": 25 }, "includeRainfallContext": { "title": "Include rainfall context", "type": "boolean", "description": "For every currently-discharging outfall, look up the nearest Environment Agency rain gauge and its rainfall total over the last 24 hours, and flag a 'dry_spell_flag' when a discharge is happening with very little recent rain nearby.", "default": true }, "onlyChangedEvents": { "title": "Only return changed events", "type": "boolean", "description": "If enabled, skip outfalls whose status has not changed since the Actor's last run (and any outfall seen for the very first time with no prior state to compare). Use this for a lean day-to-day watchlist; leave off for a full picture on the first run.", "default": false } } }, "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 } } } } } } } } } }