{ "openapi": "3.0.1", "info": { "title": "UK Planning Constraints Checker (England)", "description": "Check any English postcode or coordinate for conservation areas, listed buildings, Article 4, TPOs, flood zones, green belt, AONB, SSSI and 20+ more planning constraints, from the official planning.data.gov.uk API.", "version": "1.0", "x-build-id": "FL4SH614xFxmu3zyB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/onibaku~uk-planning-constraints/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-onibaku-uk-planning-constraints", "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/onibaku~uk-planning-constraints/runs": { "post": { "operationId": "runs-sync-onibaku-uk-planning-constraints", "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/onibaku~uk-planning-constraints/run-sync": { "post": { "operationId": "run-sync-onibaku-uk-planning-constraints", "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": [ "locations" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Postcodes (e.g. SW1A 1AA) or \"latitude, longitude\" pairs (e.g. 51.5014, -0.1419). England only. One row per location.", "items": { "type": "string" } }, "constraints": { "title": "Constraints to check", "type": "array", "description": "Leave empty to check all of them.", "items": { "type": "string", "enum": [ "conservation-area", "listed-building-outline", "listed-building", "locally-listed-building", "article-4-direction-area", "tree-preservation-zone", "tree", "flood-risk-zone", "green-belt", "area-of-outstanding-natural-beauty", "national-park", "site-of-special-scientific-interest", "special-area-of-conservation", "special-protection-area", "ramsar", "scheduled-monument", "world-heritage-site", "world-heritage-site-buffer-zone", "park-and-garden", "battlefield", "heritage-coast", "ancient-woodland", "local-nature-reserve", "national-nature-reserve", "archaeological-priority-area", "air-quality-management-area", "nutrient-neutrality-catchment", "brownfield-land" ], "enumTitles": [ "Conservation area", "Inside a listed building outline", "Listed buildings nearby", "Locally listed buildings nearby", "Article 4 direction area", "Tree preservation order area", "Protected trees nearby", "Flood zone 2 or 3", "Green belt", "National Landscape (AONB)", "National park", "Site of Special Scientific Interest", "Special Area of Conservation", "Special Protection Area", "Ramsar wetland", "Scheduled monument", "World Heritage Site", "World Heritage Site buffer zone", "Registered park or garden", "Registered battlefield", "Heritage coast", "Ancient woodland", "Local nature reserve", "National nature reserve", "Archaeological priority area", "Air quality management area", "Nutrient neutrality catchment", "On the brownfield land register" ] } }, "radiusMetres": { "title": "Search radius for nearby listed buildings and protected trees (metres)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Listed buildings and individual protected trees are stored as points, so they are found within this distance of the location. 0 turns this off. Max 500.", "default": 50 }, "includeConstraintList": { "title": "Include the detailed list of constraints", "type": "boolean", "description": "Adds a \"constraints\" array with the name, reference, grade or flood level and official link for each hit.", "default": true } } }, "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 } } } } } } } } } }