{ "openapi": "3.0.1", "info": { "title": "Rated People Scraper", "description": "Scrape ratedpeople.com, the UK's tradesperson directory. Browse rated builders, plumbers, electricians and 200+ other trades by category and town/city, or fetch specific profiles. Get company name, trade, rating, reviews, and more.", "version": "1.0", "x-build-id": "KH7VgRLfdjy1NTEYQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~rated-people-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~rated-people-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~rated-people-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byTrade", "byProfileUrls" ], "type": "string", "description": "byTrade: browse rated tradespeople by trade category (and optional UK town/city). byProfileUrls: fetch specific tradesperson profiles directly by URL.", "default": "byTrade" }, "tradeCategory": { "title": "Trade category (mode=byTrade)", "enum": [ "access-control-door-entry", "aerial-installation", "aerial-satellite-dish-installation", "air-conditioning-refrigeration", "astro-turf", "bath-resurfacing", "bathroom-design", "bathroom-fitter", "bathroom-installation", "bathroom-kitchen-and-wc-plumbing", "bathroom-repair", "bathroom-tiling", "bespoke-furniture", "bespoke-kitchens", "blacksmith-metal-worker", "blind-curtain-shutter-installation", "brick-block-paving", "brick-stone-cleaning", "bricklayers", "builders", "built-in-furniture", "burglar-repairs", "burglar-security-intruder-alarm-installation", "carbon-monoxide-alarms-installation", "carpenters-joiners", "carpet-cleaning", "carpet-fitters", "cat-flap-installation", "cavity-wall-insulation", "cctv-installation", "cctv-satellites-alarms", "cellar-basement-conversion", "chimney-building-repair", "cladding", "cleaners", "commercial-pest-control", "commercial-window-cleaning", "complete-bathroom-refurbishment", "complete-kitchen-refurbishment", "concrete-driveway", "conservatory", "conservatory-cleaning-maintenance", "crown-reduction", "crown-thinning", "damp-proofing", "decorative-cornicing-plasterwork", "decorative-glazing", "decorative-ironmongery-and-metalwork", "deep-cleaning-commercial", "deep-cleaning-domestic", "demolition", "digital-home-network", "disability-access-installation", "disabled-access-mobility-service", "domestic-appliance-repair", "domestic-house-cleaning-one-off", "domestic-house-cleaning-regular", "door-opening", "door-replacement", "door-window-painting", "drainage-specialists", "drains-installation-unblocking-cleaning", "dry-lining-plasterboard-installation", "dry-lining-plasterboard-repair", "electric-boiler-installation", "electric-boiler-repair", "electric-boiler-service", "electric-car-charging-point-installation", "electric-oven-hob-installation", "electric-underfloor-heating", "electrical-inspection-condition-report", "electrical-installation-testing", "electricians", "emergency-24-hour-locksmith", "emergency-electrician", "emergency-plumber", "end-of-tenancy-cleaning", "external-lighting", "external-rendering", "external-tiling", "external-wall-insulation", "external-wall-painting", "fire-alarm-installation", "fireplace", "fitted-bedrooms-wardrobes", "fitted-kitchens", "flat-pack-furniture-assembly", "flat-roof-installation-repair", "floor-fitters", "floor-sanding-finishing", "floor-tiling", "garage-conversion", "garage-doors-installation-repair", "garden-clearance", "garden-design", "garden-maintenance", "garden-office-studio-construction", "garden-shed-playhouse", "garden-wall", "gardener-landscape-gardeners", "gas-boiler-installation", "gas-boiler-repair", "gas-boiler-service", "gas-cooker-hob-installation", "gas-cooker-hob-repair", "gas-fire", "gas-heating-engineer", "general-fitted-furniture", "groundwork-foundations", "guttering-and-rainwater-pipe", "handyperson", "home-maintenance-repair", "heat-pump", "home-improvements", "hot-tub-installation-repair", "hot-water-tank-appliance-tank-thermostats", "house-clearance", "house-extension", "house-removals", "internal-lighting", "internal-painting-decorating", "internal-rendering", "jet-power-washing", "kitchen-design-installation", "kitchen-specialists", "kitchen-tiling", "kitchen-worktops-stone", "laminate-flooring", "laminate-wooden-kitchen-worktops", "landlord-reports-safety-checks", "landscaping", "lawn-care-services-grass-cutting-turfing-seeding", "leadwork", "linoleum-flooring", "lock-fitting-repair", "locksmiths", "loft-conversion", "loft-conversion-specialists", "log-cabins-timber-framed-building", "man-woman-with-a-van", "metal-kitchen-worktops", "metal-staircases", "mould-damp-control", "office-commercial-cleaning", "oil-fired-boiler", "oven-cleaning", "painter-and-decorator", "partition-wall", "pebble-dashing", "period-listed-building-works", "period-restoration", "perspex-protective-screens", "pest-control", "pizza-oven", "planting", "plaster-skimming", "plasterers-renderers", "plastic-rubber-flooring", "plumbers", "plumbing-repair-maintenance", "pointing-repointing", "polished-concrete", "polished-other-plaster-finish", "pond-water-feature", "porch-canopy", "post-construction-cleaning", "power-showers-and-pump", "radiator", "radiator-covers", "removals", "renewables-specialists", "repeat-garden-maintenance", "repeat-wheelie-bin-clean", "residential-pest-control", "resin-driveway", "roller-shutters-installation-repair", "roof-cleaning", "roof-insulation", "roofers", "scaffolding", "screeding", "security-fencing", "security-gates-bollard", "security-grill", "security-systems-alarms", "septic-tanks-installation-emptying-cleaning", "single-double-glazing", "skirting-board-installation", "slate-tiled-roof", "smoke-alarm-installation", "soil-irrigation-drainage", "solar-panel-cleaning-repair", "solar-panel-installation", "solid-wood-flooring", "sound-audio-visual-installation", "sound-proofing", "specialist-removals", "specialist-services", "sprinkler-system", "standard-coving", "steel-fabrication-structural-steelwork", "stone-concrete-paving", "stonework-stone-cladding", "stoneworkers-stonemasons", "storage", "stored-gas", "stored-oil", "stump-grinding", "suspended-ceiling", "swimming-pool-design", "swimming-pool-installation", "swimming-pool-maintenance", "swimming-pool-specialists", "tarmac", "thatched-roof", "thermal-insulation", "tilers", "timber-preservation-woodworm-rot", "traditional-craftspeople", "tree-felling", "tree-surgeons", "tree-surgery-consultancy", "underfloor-insulation", "underpinning-piling-foundations", "upvc-fascias-soffits-cladding", "upvc-windows-door", "velux-skylight-window", "vinyl-flooring", "wall-murals-paint-effects", "wall-tiling", "waste-removal", "water-tanks-and-immersion-heater", "water-underfloor-heating", "wet-room-installation", "whole-internal-refurbishment", "window-cleaning", "window-fitter-conservatory-installer", "wood-floor-sanding-staining", "wooden-casement-window", "wooden-cladding-fascias-soffits", "wooden-decking", "wooden-doors-external", "wooden-doors-internal", "wooden-metal-gates", "wooden-metal-wire-fences", "wooden-sash-window", "wooden-shutter", "wooden-staircases", "zinc-metal-roof" ], "type": "string", "description": "Trade/skill category to browse. Required for mode=byTrade.", "default": "plumbers" }, "location": { "title": "UK town / city (mode=byTrade, optional)", "type": "string", "description": "Narrow results to a UK town or city. ratedpeople.com only publishes a dedicated town page for a handful of towns (\"London\" is confirmed reliable); for any other town the actor automatically falls back to the nationwide listing for this trade and reports the fallback in the run's status message, so you always get results instead of a silent 0. Leave blank for the national listing for this trade.", "default": "" }, "profileUrls": { "title": "Profile URLs (mode=byProfileUrls)", "type": "array", "description": "Full ratedpeople.com/profile/... URLs (or bare profile slugs) to fetch directly. Required for mode=byProfileUrls.", "default": [], "items": { "type": "string" } }, "fetchFullProfile": { "title": "Fetch full profile details", "type": "boolean", "description": "For mode=byTrade: also visit each tradesperson's full profile page for extra fields (town/postcode, work-area coordinates, badges, verified status, gallery images, up to 10 detailed reviews). Roughly doubles requests and run time.", "default": false }, "minRating": { "title": "Minimum rating (0-10 scale)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include tradespeople whose average rating is at least this value, on Rated People's native 0-10 scale (e.g. 8 = 4-out-of-5 stars or better). Records missing a rating always pass.", "default": 0 }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only include tradespeople with at least this many reviews. Records missing a review count always pass.", "default": 0 }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Only include tradespeople whose company name, description, trades, or skills contain this text (case-insensitive).", "default": "" }, "verifiedOnly": { "title": "Verified profiles only", "type": "boolean", "description": "Only include profiles flagged as verified by Rated People. Requires `fetchFullProfile` to be effective (verification status is only present on the full profile page); listing-only records always pass this filter.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of tradesperson records to return. Note: for mode=byTrade, ratedpeople.com's listing page only ever renders its first ~20 results per trade/town (no working pagination on that route), so byTrade output caps around 20 regardless of this value; use mode=byProfileUrls with specific profile links to fetch more than 20.", "default": 20 } } }, "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 } } } } } } } } } }