{ "openapi": "3.0.1", "info": { "title": "UK Planning Applications Scraper — All Councils", "description": "Get every UK planning application in one run — all ~420 councils, no API key. Filter by council, type, status, size or date and export address, decision, dates, coordinates and the architect firm behind each project. Ideal for construction leads. Billed per result.", "version": "0.0", "x-build-id": "Tz81U0xli9NK8T9Du" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~uk-planning-applications-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-uk-planning-applications-scraper", "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/memo23~uk-planning-applications-scraper/runs": { "post": { "operationId": "runs-sync-memo23-uk-planning-applications-scraper", "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/memo23~uk-planning-applications-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-uk-planning-applications-scraper", "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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Free-text terms matched against the application description (e.g. 'solar', 'extension', 'demolition', 'wind turbine'). Each keyword runs its own search.", "items": { "type": "string" } }, "startUrls": { "title": "PlanIt application URLs (optional)", "type": "array", "description": "PlanIt application-page URLs like https://www.planit.org.uk/planapplic/Wiltshire/PL/2026/04272/ — scraped directly. Search URLs are also accepted (their search term is folded into keywords).", "items": { "type": "string" } }, "authorities": { "title": "Councils / planning authorities", "type": "array", "description": "Restrict to these local planning authorities by name (e.g. Cornwall, Wiltshire, Birmingham, Leeds). Each runs as its own search. Leave empty for all ~420 UK councils.", "items": { "type": "string" } }, "appType": { "title": "Application type", "type": "string", "description": "One application type. Allowed: Full, Outline, Amendment, Conditions, Trees, Advertising, Heritage, Listed, Telecoms, Certificate, Other. Leave empty for all." }, "appState": { "title": "Application state", "type": "string", "description": "One decision state. Allowed: Undecided, Permitted, Rejected, Withdrawn, Conditions, Referred, Unresolved, Other. Leave empty for all." }, "appSize": { "title": "Application size", "type": "string", "description": "One size band. Allowed: Small, Medium, Large. Leave empty for all." }, "recentDays": { "title": "Only applications from the last N days", "minimum": 1, "type": "integer", "description": "Fast path for daily monitoring — only applications changed in the last N days. Leave empty to use a date range or return everything." }, "startDate": { "title": "Date from (YYYY-MM-DD)", "type": "string", "description": "Only applications on/after this date. Format YYYY-MM-DD." }, "endDate": { "title": "Date to (YYYY-MM-DD)", "type": "string", "description": "Only applications on/before this date. Format YYYY-MM-DD." }, "minDwellings": { "title": "Minimum dwellings", "minimum": 1, "type": "integer", "description": "Only applications proposing at least this many dwellings — useful for targeting larger residential developments. Leave empty for all." }, "onlyWithAgentContact": { "title": "Only applications with an agent (architect) contact", "type": "boolean", "description": "When enabled, only applications that carry an agent name or company are returned — a focused construction-leads list. Applications with no published agent are skipped (and not billed).", "default": false }, "enrichEmails": { "title": "Enrich agent/applicant with contact emails (experimental)", "type": "boolean", "description": "If enabled, tries to find a contact email + website for the agent's company (or the applicant) by discovering their website. Adds contactEmail + contactWebsite columns plus a detailed emailEnrichment object. Best-effort.", "default": false }, "maxItems": { "title": "Maximum items to scrape", "minimum": 1, "type": "integer", "description": "Hard cap on the number of applications collected. Use this to limit billing.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Maximum number of applications processed in parallel.", "default": 10 }, "minConcurrency": { "title": "Min concurrency", "minimum": 1, "type": "integer", "description": "Minimum number of requests processed in parallel.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Number of retries before a failed request is given up.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "PlanIt is a public API reachable without a proxy. A proxy is optional; residential is the safe default for large runs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }