{ "openapi": "3.0.1", "info": { "title": "Rated People Scraper [$1💰] | Tradespeople | UK Leads", "description": "Build a UK tradespeople database from Rated People. Extract plumbers, electricians, builders, roofers and 200+ trades with ratings, verified review texts, work area and trust badges for lead generation, market research and reputation monitoring.", "version": "0.0", "x-build-id": "krmbEdXXbnIHfZNBK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~ratedpeople-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-ratedpeople-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/ahmed_jasarevic~ratedpeople-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-ratedpeople-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/ahmed_jasarevic~ratedpeople-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-ratedpeople-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. \"plumbers\", \"electricians\", \"builders\", \"roofers\". Use the site's URL slug (see README for the full list).", "default": [ "plumbers" ], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Optional UK locations to narrow results. Use the site's path format, e.g. \"west-midlands/birmingham\", \"greater-manchester/manchester\", \"berkshire/reading\". Leave empty for the nationwide listing of each trade.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional: paste full Rated People trade/location listing URLs directly, e.g. https://www.ratedpeople.com/local-plumbers/west-midlands/birmingham. Used in addition to trades x locations.", "items": { "type": "string" } }, "exploreLocations": { "title": "Explore all locations", "type": "boolean", "description": "Each listing page shows only ~18 tradespeople and the site has no pagination. When enabled, the crawler automatically follows the site's deeper location pages (region -> district -> town) to keep finding new traders until the item limit is reached.", "default": true }, "fetchFullProfile": { "title": "Fetch full profiles", "type": "boolean", "description": "Visit each tradesperson's profile page to get the aggregate rating, review count, review texts (saved to the separate run-scoped reviews dataset), work area, badges and trades/skills. Turn off for a fast listing-only scrape (name, trade, description, latest review).", "default": true }, "scrapeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "Extract review texts from each profile. When on, reviews are saved to a SEPARATE run-scoped 'reviews' dataset (one row per review; shown on the run's Storage tab and Output tab, ID stored in the run's key-value store under \"reviews-dataset\") so the main dataset stays clean company data. When off, no review texts are scraped at all.", "default": true }, "maxReviewsPerProfile": { "title": "Max reviews per profile", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of review texts to keep per profile (the profile page shows up to ~10 recent reviews). Only applies when 'Scrape reviews' is on. The review texts land in the separate run-scoped reviews dataset.", "default": 10 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of tradesperson records to return.", "default": 50 } } }, "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 } } } } } } } } } }