{ "openapi": "3.0.1", "info": { "title": "Rated People Scraper — UK Trade Leads, Ratings & Reviews", "description": "Scrape UK tradespeople from Rated People by trade and town: business name, rating, review count, reviews, service area, badges and profile URL.", "version": "0.1", "x-build-id": "wMXwKtwq0HywYI2uz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~rated-people-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-rated-people-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/scrapersdelight~rated-people-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-rated-people-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/scrapersdelight~rated-people-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-rated-people-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": { "trades": { "title": "Trades", "type": "array", "description": "Trade categories to scrape, e.g. \"Plumber\", \"Electrician\", \"Roofer\", \"Bathroom Fitter\". Free text is normalized to Rated People's slug (e.g. Plumber -> plumbers) and validated against its trade list.", "items": { "type": "string" } }, "locations": { "title": "Locations (UK towns / cities)", "type": "array", "description": "Optional. UK towns or cities to scrape each trade in, e.g. \"London\", \"Manchester\", \"Birmingham\". Combined with every trade (trades x locations). You can also paste a Rated People location path, e.g. \"west-midlands/birmingham\". Leave empty to scrape each trade's nationwide top traders.", "items": { "type": "string" } }, "startUrls": { "title": "Search URLs (advanced)", "type": "array", "description": "Optional: paste Rated People trade/location URLs directly, e.g. https://www.ratedpeople.com/local-plumbers/west-midlands/birmingham . Used in addition to trades x locations above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "expandLocationTowns": { "title": "Expand to nearby towns", "type": "boolean", "description": "For each resolved location, also scrape every sibling postal town Rated People lists for it (e.g. all West Midlands towns near Birmingham). A big volume multiplier. Note: each town page returns up to 20 traders.", "default": false }, "maxItems": { "title": "Max leads", "minimum": 0, "type": "integer", "description": "Stop after this many unique traders (0 = no limit). Each unique trader is charged once.", "default": 100 }, "enrichProfiles": { "title": "Enrich from profile pages", "type": "boolean", "description": "Open each trader's profile to add the full reviews list, service-area polygon, town/postcode, badges, verification status and (when published) a phone number. Slower but far richer. Turn off for fast rating-only lists.", "default": true }, "onlyWithPhone": { "title": "Only keep traders with a phone", "type": "boolean", "description": "Drop any trader that does not publish a phone number. Note: most Rated People profiles mask the phone, so this will keep only a small subset. Requires 'Enrich from profile pages'.", "default": false }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 300, "type": "integer", "description": "Politeness delay between page loads. Lower is faster but more likely to be rate-limited.", "default": 1500 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Rated People is behind Cloudflare and blocks direct (no-proxy) requests. Apify Proxy RESIDENTIAL, country GB is required and is the default.", "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 } } }, "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 } } } } } } } } } }