{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper", "description": "Search and export official planning.data.gov.uk planning applications with council identifiers, proposals, dates, decisions, geometry, and provenance.", "version": "0.1", "x-build-id": "Zw7E4Kb6bvJs84iCs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~uk-planning-applications/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-uk-planning-applications", "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/automation-lab~uk-planning-applications/runs": { "post": { "operationId": "runs-sync-automation-lab-uk-planning-applications", "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/automation-lab~uk-planning-applications/run-sync": { "post": { "operationId": "run-sync-automation-lab-uk-planning-applications", "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": { "organisationEntity": { "title": "Council / organisation entity IDs", "uniqueItems": true, "type": "array", "description": "Official numeric organisation-entity identifiers from planning.data.gov.uk. Multiple values are combined by the source API.", "items": { "type": "integer" } }, "references": { "title": "Planning application references", "uniqueItems": true, "type": "array", "description": "Exact official application references, for example AWDM/0550/25.", "items": { "type": "string", "minLength": 1 } }, "entityIds": { "title": "Planning Data entity IDs", "uniqueItems": true, "type": "array", "description": "Exact numeric planning.data.gov.uk entity IDs for deterministic lookups.", "items": { "type": "integer" } }, "postcodeOrUprn": { "title": "Postcode or UPRN", "minLength": 1, "type": "string", "description": "A UK postcode or Unique Property Reference Number accepted by the official API." }, "submittedSince": { "title": "Submitted since", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Return applications submitted on or after this date (YYYY-MM-DD)." }, "submittedUntil": { "title": "Submitted until", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Keep applications submitted on or before this date (YYYY-MM-DD). This bound is applied after retrieval." }, "updatedSince": { "title": "Updated in source since", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Return records whose Planning Data entry date is on or after this date (YYYY-MM-DD), useful for scheduled monitoring." }, "decision": { "title": "Decision values", "uniqueItems": true, "type": "array", "description": "Keep exact decision values (case-insensitive), such as Approve or Refuse.", "items": { "type": "string", "minLength": 1 } }, "proposalKeywords": { "title": "Required proposal keywords", "uniqueItems": true, "type": "array", "description": "Keep records whose proposal contains every supplied term, case-insensitive. Increase the scan limit for rare terms.", "items": { "type": "string", "minLength": 1 } }, "geometryWkt": { "title": "Search geometry (WKT)", "minLength": 8, "type": "string", "description": "POINT, POLYGON, or MULTIPOLYGON in WKT format used by the official spatial API." }, "geometryRelation": { "title": "Geometry relation", "enum": [ "intersects", "within", "contains" ], "type": "string", "description": "Spatial relationship used with Search geometry.", "default": "intersects" }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum useful planning applications saved to the default dataset.", "default": 20 }, "maxScanItems": { "title": "Maximum source records scanned", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety bound for source rows inspected when local decision, date, or keyword filters are selective. Must be at least Maximum results.", "default": 20 } } }, "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 } } } } } } } } } }