{ "openapi": "3.0.1", "info": { "title": "UK Postcode Report: Planning, Crime, Flood & Sold Prices", "description": "One structured report per UK postcode: ONS geography and deprivation rank, planning constraints (conservation area, Article 4, listed buildings, green belt, flood zone, SSSI and 30+ more), street-level crime counts, live flood warnings and recent Land Registry sold prices. Official open data only.", "version": "1.0", "x-build-id": "ogZDZUO8ZYVmcQrvJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mercury_ops~uk-postcode-area-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mercury_ops-uk-postcode-area-report", "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/mercury_ops~uk-postcode-area-report/runs": { "post": { "operationId": "runs-sync-mercury_ops-uk-postcode-area-report", "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/mercury_ops~uk-postcode-area-report/run-sync": { "post": { "operationId": "run-sync-mercury_ops-uk-postcode-area-report", "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": [ "postcodes" ], "properties": { "postcodes": { "title": "Postcodes", "type": "array", "description": "Full UK postcodes, one per line (e.g. BA1 2LR). Up to 500 per run.", "items": { "type": "string" } }, "includePlanning": { "title": "Planning constraints (England)", "type": "boolean", "description": "Designations at the postcode's point from planning.data.gov.uk: conservation area, Article 4, listed building outline, green belt, flood risk zone, National Landscape, SSSI, TPO areas and more.", "default": true }, "listedBuildingRadiusMetres": { "title": "Listed buildings within (metres)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "List Historic England listed buildings within this distance (square around the point). 0 to skip.", "default": 100 }, "includeCrime": { "title": "Street-level crime (latest month)", "type": "boolean", "description": "Counts by category within police.uk's standard 1-mile radius for the latest published month (England, Wales, Northern Ireland).", "default": true }, "includeFloodWarnings": { "title": "Live flood warnings (England)", "type": "boolean", "description": "Environment Agency flood alerts and warnings currently in force nearby.", "default": true }, "floodWarningRadiusKm": { "title": "Flood warning radius (km)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Search radius for live flood warnings.", "default": 5 }, "includeSoldPrices": { "title": "Sold prices at the postcode", "type": "boolean", "description": "HM Land Registry sales at this exact postcode: count, median and latest five (England and Wales).", "default": true }, "soldPriceYears": { "title": "Sold price lookback (years)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many years of sales to include.", "default": 5 } } }, "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 } } } } } } } } } }