{ "openapi": "3.0.1", "info": { "title": "FreeIndex Scraper - UK Business Directory", "description": "Scrape FreeIndex, a UK business directory with 450,000+ reviews. Search by category and city, or fetch full business profiles by URL. Get names, addresses, phone numbers, websites, ratings, reviews, opening hours, and social links.", "version": "1.0", "x-build-id": "Ogee9Ny1fWEnX1kXx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~freeindex-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-freeindex-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~freeindex-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-freeindex-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~freeindex-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-freeindex-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": [ "search", "byUrl" ], "type": "string", "description": "What to fetch: search a category + city, or fetch full business profiles from direct FreeIndex profile URLs.", "default": "search" }, "category": { "title": "Category", "enum": [ "custom", "accountants", "acupuncture", "advertising_agencies", "airport_transfers", "architects", "bathroom_fitters", "beauty", "beauty_salons", "bookkeepers", "builders", "building_materials", "business_advice", "cake_makers", "car_parts_and_accessories", "car_repair_garages", "carpenters", "carpet_cleaning", "carpet_fitters", "caterers", "cctv", "central_heating_services", "chartered_accountants", "chauffeur_driven_car_hire", "childminders", "childrens_parties", "childrens_services", "cleaners", "clothing_and_accessories", "commercial_cleaning", "complementary_therapy", "computer_repair", "computer_support", "computer_training", "copywriters", "counselling", "couriers", "curtains_and_blinds", "dance_schools", "decorators", "dentists", "doctors_and_clinics", "dog_walkers", "double_glazing", "driveway_cleaning", "driving_instructors", "electricians", "entertainers", "environmental_services", "estate_agents", "event_organisers", "event_photography", "fashion", "financial_advisers", "fitness", "flooring", "florists", "food_retailers", "furniture", "gardeners", "gifts", "glaziers", "graphic_designers", "groundworkers", "gutter_cleaning", "hair_extensions", "hairdressers", "handymen", "haulage", "health_and_safety", "human_resources", "hypnotherapy", "industrial_equipment", "interior_design", "internet_marketing", "intruder_alarms", "it_consultancy", "jewellery", "joinery", "kitchen_fitters", "ladies_clothing", "lawyers", "leaflet_distributors", "letting_agents", "life_coaching", "locksmiths", "loft_conversions", "make_up_artists", "management_consultants", "manufacturing", "market_research", "marketing", "martial_arts_and_self_defence", "massage_therapists", "mental_health_care", "minibus_hire", "mobile_beauty_therapists", "mobile_discos", "mobile_hairdressers", "mobile_mechanics", "mortgages", "music_production", "music_shops", "music_tuition", "networking", "office_cleaning", "office_furniture", "office_space", "online_advertising", "osteopathy", "payroll_accountants", "performing_arts", "personal_trainers", "pest_control", "pet_sitting", "photographers", "physiotherapy", "plasterers", "plumbers", "portable_appliance_testing", "portrait_photographers", "printing", "promotional_products", "proofreaders", "property_consultants", "psychics_and_clairvoyants", "psychotherapy", "public_relations", "recording_studios", "recruitment_agencies", "removals_and_relocation", "restaurants", "roofing", "search_engine_optimisation", "secretarial_services", "security_services", "sign_makers", "software_development", "solar_panel_installers", "solicitors", "sports", "sports_massage", "surveyors", "tailors", "taxis", "tilers", "toy_shops", "translation_services", "travel_agents", "tree_surgeons", "van_hire", "video_production", "waste_disposal", "web_designers", "web_development", "web_hosting", "wedding_cakes", "wedding_car_hire", "wedding_dresses", "wedding_hair_and_makeup", "wedding_photographers", "wedding_videos", "weight_loss", "yoga" ], "type": "string", "description": "Business category to search for. Pick a common category, or choose 'Custom category' and type your own below (mode=search).", "default": "plumbers" }, "customCategory": { "title": "Custom category (overrides selection above)", "type": "string", "description": "Free-text category slug not in the curated list above, e.g. 'roofing' or 'web_designers' (mode=search). Takes priority over 'Category' when set. Use underscores, matching FreeIndex's own category-slug style (see a category page URL on freeindex.co.uk for the exact slug)." }, "city": { "title": "City", "enum": [ "custom", "aberdeen", "ashford", "aylesbury", "basingstoke", "bath", "bedford", "belfast", "birmingham", "blackburn", "blackpool", "bolton", "bournemouth", "bradford", "brighton", "bristol", "cambridge", "cardiff", "chelmsford", "cheltenham", "chester", "chesterfield", "colchester", "coventry", "crawley", "croydon", "derby", "devon", "dundee", "eastbourne", "edinburgh", "exeter", "fulham", "glasgow", "gloucester", "guildford", "harrogate", "harrow", "high-wycombe", "huddersfield", "hull", "ilford", "ipswich", "islington", "kent", "leamington-spa", "leeds", "leicester", "lincoln", "liverpool", "london", "luton", "maidstone", "manchester", "middlesbrough", "milton-keynes", "newcastle", "newport", "northampton", "norwich", "nottingham", "perth", "peterborough", "plymouth", "poole", "portsmouth", "reading", "redditch", "rochdale", "sheffield", "slough", "solihull", "southampton", "southend-on-sea", "st-albans", "stevenage", "stockport", "stoke-on-trent", "sunderland", "sutton-coldfield", "swansea", "swindon", "torquay", "warrington", "watford", "weston-super-mare", "wimbledon", "wolverhampton", "worcester", "worthing", "york" ], "type": "string", "description": "UK city or town to search in. Pick one of the curated cities, or choose 'Custom city' and type your own below (mode=search).", "default": "london" }, "customCity": { "title": "Custom city (overrides selection above)", "type": "string", "description": "Free-text UK city/town slug not in the curated list above (mode=search). Takes priority over 'City' when set. Not every city+category combination has a results page on FreeIndex -- if none exists, the run returns 0 records with a clear status message rather than an error." }, "fetchDetails": { "title": "Fetch full business profiles", "type": "boolean", "description": "For each search result, also visit its business profile page to collect phone number, full address, postcode, coordinates, opening hours, website, and social links. Recommended -- without this, results only include name, locality, rating, and review count (mode=search).", "default": true }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "rating", "reviewCount", "name" ], "type": "string", "description": "How to order search results after fetching (mode=search). FreeIndex itself ranks Premium Members first; 'rating'/'reviewCount'/'name' are applied client-side across the fetched batch.", "default": "relevance" }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only return businesses rated at least this many stars, e.g. 4 for 4.0+ (mode=search). 0 means no minimum. Businesses with no rating are excluded once this is set above 0.", "default": 0 }, "minReviews": { "title": "Minimum review count", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only return businesses with at least this many reviews (mode=search). 0 means no minimum.", "default": 0 }, "premiumOnly": { "title": "Premium members only", "type": "boolean", "description": "Only return businesses flagged as a FreeIndex 'Premium Member' (mode=search).", "default": false }, "profileUrls": { "title": "Business profile URLs (mode=byUrl)", "type": "array", "description": "Direct FreeIndex business profile URLs to fetch, e.g. https://www.freeindex.co.uk/profile(taylors-heating-solutions)_85620.htm. Use the 'sourceUrl' field from search results.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "FreeIndex business profile URL." } } }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on the number of business records to return. FreeIndex's own city+category listing pages return up to 20 businesses each (mode=search); use mode=byUrl with a larger list to fetch more records in one run.", "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 } } } } } } } } } }