{ "openapi": "3.0.1", "info": { "title": "Checkatrade Scraper | UK Trades & Lead Data", "description": "Collect Checkatrade UK trade and lead data at scale. Search trades across any UK area, enrich every business with scores, reviews, services, vetting history and contact numbers. Clean JSON streamed to your dataset in real time. Ideal for lead-gen, CRM enrichment and local SEO.", "version": "0.0", "x-build-id": "puCSO0zPvd4g6I4b7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Checkatrade-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Checkatrade-Real-Time-Data-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/b2b_leads~Checkatrade-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Checkatrade-Real-Time-Data-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/b2b_leads~Checkatrade-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Checkatrade-Real-Time-Data-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": { "enableSearch": { "title": "Trade & area search", "type": "boolean", "description": "Search Checkatrade by trade and area (town, county, or postcode). Enabled by default.", "default": true }, "searchTasks": { "title": "Search tasks", "type": "array", "description": "Primary input. Add one row per search: a trade plus a UK area (town/county name or postcode).", "items": { "type": "object", "properties": { "trade": { "title": "Trade", "type": "string", "description": "Trade or service (e.g. \"Plumber\", \"Electrician\", \"Builder\", \"Roofer\", \"Painter-Decorator\", \"Handyman\"). Common job titles are mapped to the right trade automatically.", "editor": "textfield" }, "location": { "title": "Area", "type": "string", "description": "UK town or county (e.g. \"Bristol\", \"Leeds\", \"City Of Edinburgh\") or a postcode area (e.g. \"KT1\", \"BS30\").", "editor": "textfield" }, "maxResults": { "title": "Max businesses", "type": "integer", "description": "Maximum businesses for this task. Uses the global default below when omitted.", "minimum": 1, "editor": "number" } }, "required": [ "trade", "location" ] } }, "maxResultsPerTask": { "title": "Default max businesses per task", "minimum": 1, "type": "integer", "description": "Default maximum businesses per search task. Override per task in the list above.", "default": 10 }, "maxPagesPerTask": { "title": "Max result pages per task", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many result pages of the same search to collect (safety cap for very large runs).", "default": 5 }, "enableProfileDetails": { "title": "Profile & lead details", "type": "boolean", "description": "Enrich every business in place with its full profile: trading description, phone number, service area, skills and services, vetting information, membership date, and customer review signals. Every business is still exported even when a profile has little detail — this adds a little extra time per business.", "default": true }, "maxReviewsPerProfile": { "title": "Reviews to include per profile", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many recent customer reviews to attach to each business when profile details are on (0 disables review capture).", "default": 3 }, "enableContactDiscovery": { "title": "Contact discovery (website, email, socials)", "type": "boolean", "description": "Adds the business's own website, contact emails, extra phone numbers, and social profiles where they are publicly available and verified against the business name and area. Off by default because it adds extra time per business.", "default": false }, "enableScrapeByUrl": { "title": "Scrape By URL", "type": "boolean", "description": "Collect specific Checkatrade business profiles instead of searching.", "default": false }, "scrapeUrls": { "title": "Profile URLs", "type": "array", "description": "Checkatrade business profile links to collect (one per line), e.g. https://www.checkatrade.com/trades/hqplumbing", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max total items", "minimum": 1, "type": "integer", "description": "Global cap on total dataset rows across all features. Set high for large runs (e.g. 10000+). Note: the run also respects your max total charge for this run.", "default": 10000 }, "concurrency": { "title": "Parallel detail lookups", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many detail lookups to run in parallel (1–8). Higher is faster; 4 is a good default.", "default": 4 }, "delayBetweenRequestsMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Polite pacing between collections (0–5000 ms). Higher values are slower but gentler.", "default": 1200 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an ADDITIONAL real-time push. When set, each new record is also POSTed to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Apify residential proxy (United Kingdom) is enabled by default for reliable collection of this UK directory.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "GB" } } } }, "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 } } } } } } } } } }