{ "openapi": "3.0.1", "info": { "title": "UK Flood Warnings & River Levels Area Monitor", "description": "Current UK flood warnings and alerts, plus the latest river and sea level readings from monitoring stations, for any point and radius in England, from the Environment Agency real-time flood-monitoring API. Includes an alert mode returning only new or changed warnings for scheduled area-watch runs.", "version": "0.0", "x-build-id": "4NM34cI2BKzUH2dpg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tabulary~uk-flood-risk-area-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tabulary-uk-flood-risk-area-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/tabulary~uk-flood-risk-area-monitor/runs": { "post": { "operationId": "runs-sync-tabulary-uk-flood-risk-area-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/tabulary~uk-flood-risk-area-monitor/run-sync": { "post": { "operationId": "run-sync-tabulary-uk-flood-risk-area-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", "required": [ "lat", "long" ], "properties": { "lat": { "title": "Latitude", "type": "number", "description": "Latitude (WGS84) of the centre point of the area to check, e.g. 52.4 for a point near Norwich. Convert a postcode or address to coordinates first (for example with postcodes.io or Google Maps)." }, "long": { "title": "Longitude", "type": "number", "description": "Longitude (WGS84) of the centre point, e.g. 1.6 for a point near Norwich." }, "dist": { "title": "Search radius (km)", "minimum": 1, "maximum": 50, "type": "number", "description": "How far from the point to look for flood warnings and monitoring stations, in kilometres.", "default": 15 }, "minSeverity": { "title": "Minimum warning severity", "enum": [ "", "1", "2", "3" ], "type": "string", "description": "Only include flood warnings at least this severe: 1 = Severe Flood Warning only, 2 = also include Flood Warning, 3 = also include Flood Alert (least severe). Leave on \"All\" for every current warning and alert, including ones no longer in force.", "default": "" }, "includeRiverLevels": { "title": "Include river/sea level readings", "type": "boolean", "description": "Also return the latest water-level reading from each monitoring station in the search radius, not just flood warnings. Turn off to save cost if you only want warnings.", "default": true }, "maxStations": { "title": "Maximum stations for level readings", "minimum": 1, "maximum": 200, "type": "integer", "description": "Stop fetching level readings after this many monitoring stations in the radius. Each station reading is one billable result.", "default": 30 }, "onlyNewWarnings": { "title": "Only new/changed warnings (alert mode)", "type": "boolean", "description": "For scheduled recurring runs: only output a flood warning if it is new or its message has changed since the last run with the same area and severity filter. River level readings are unaffected and are always returned fresh.", "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 } } } } } } } } } }