# FreeIndex Scraper - UK Business Directory (`crawlerbros/freeindex-scraper`) Actor 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. - **URL**: https://apify.com/crawlerbros/freeindex-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Automation, Lead generation, SEO tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## FreeIndex Scraper - UK Business Directory Scrape **FreeIndex** (freeindex.co.uk) — a UK business directory with 450,000+ business reviews. Search any business category in any UK city and get names, addresses, phone numbers, ratings, reviews, opening hours, and websites. Optionally fetch each business's full profile for GPS coordinates, structured opening hours, and social links. No login, no cookies, no API key required. ### What this actor does - **Two modes:** `search` (category + city) and `byUrl` (direct business profile URLs) - **163 curated categories** to pick from, or type any custom category slug - **90 curated UK cities and towns**, or type any custom city slug - **Sort by** relevance, rating, review count, or name (A-Z) - **Filter by** minimum rating (1-5 stars), minimum review count, or "Premium Member" businesses only - **Rich business profiles** — full address, postcode, GPS coordinates, structured opening hours, website, Facebook/Instagram/LinkedIn/Twitter/YouTube/TikTok links - **Empty fields are omitted** — you only ever see fields that were actually found for a business ### Output per business - `businessName` — business name - `description` — business-provided description (when profile fetched) - `category`, `categoryGroup` — primary listed category and its parent group (when profile fetched) - `rating` — average star rating (1-5), `reviewCount` — number of reviews - `isPremiumMember` — true if flagged as a FreeIndex Premium Member (search-listing field) - `highlights[]` — short marketing bullet points shown on the search listing (when present) - `telephone`, `website` - `addressStreet`, `addressLocality`, `addressRegion`, `postalCode`, `fullAddress` (when profile fetched) - `latitude`, `longitude` — GPS coordinates (when profile fetched) - `openingHours[]` — structured opening hours (`{day, opens, closes}` per day; when profile fetched and published) - `priceRange` (when profile fetched and published) - `images[]` — business photo URLs (when profile fetched) - `recentReviews[]` — the business's most recent customer reviews (`{author, date, rating, text}` per review; when profile fetched and reviews exist) - `facebookUrl`, `instagramUrl`, `linkedinUrl`, `twitterUrl`, `youtubeUrl`, `tiktokUrl` — social links the business has published (when profile fetched) - `memberSince` — ISO date (`YYYY-MM-DD`) the business joined FreeIndex (when profile fetched) - `lastUpdated` — ISO date (`YYYY-MM-DD`) the business last updated its FreeIndex listing (when profile fetched) - `listingId` — FreeIndex's internal numeric listing ID - `searchCategory`, `searchCity` — the search parameters used (mode=search) - `sourceUrl` — canonical FreeIndex profile URL for the business - `recordType: "business"`, `scrapedAt` ### Input | Field | Type | Default | Description | |---|---|---|---| | `mode` | string (select) | `search` | `search` (category + city) or `byUrl` (fetch by URL) | | `category` | string (select) | `plumbers` | Pick one of 163 curated categories, or `custom` to use `customCategory` (mode=search) | | `customCategory` | string | – | Any free-text category slug, overrides `category` (mode=search) | | `city` | string (select) | `london` | Pick one of 90 curated UK cities, or `custom` to use `customCity` (mode=search) | | `customCity` | string | – | Any free-text city slug, overrides `city` (mode=search) | | `fetchDetails` | boolean | `true` | Also visit each business's profile page for phone, address, coordinates, opening hours, website, and social links | | `sortBy` | string (select) | `relevance` | `relevance` / `rating` / `reviewCount` / `name` — applied client-side across the fetched batch | | `minRating` | integer | `0` (no minimum) | Only return businesses rated at least 1-5 stars | | `minReviews` | integer | `0` (no minimum) | Only return businesses with at least this many reviews | | `premiumOnly` | boolean | `false` | Only return FreeIndex Premium Member businesses | | `profileUrls` | array | – | FreeIndex profile URLs to fetch directly (mode=byUrl) | | `maxItems` | int | `20` | Hard cap on returned records (1-200) | #### Example: search plumbers in London ```json { "mode": "search", "category": "plumbers", "city": "london", "maxItems": 20 } ```` #### Example: highest-rated electricians in Manchester with 10+ reviews ```json { "mode": "search", "category": "electricians", "city": "manchester", "sortBy": "rating", "minReviews": 10, "maxItems": 20 } ``` #### Example: Premium Member accountants in Birmingham, listing-only (faster) ```json { "mode": "search", "category": "accountants", "city": "birmingham", "premiumOnly": true, "fetchDetails": false, "maxItems": 20 } ``` #### Example: fetch specific business profiles ```json { "mode": "byUrl", "profileUrls": [ { "url": "https://www.freeindex.co.uk/profile(taylors-heating-solutions)_85620.htm" } ] } ``` ### Use cases - **Local lead generation** — build a prospect list of UK businesses by trade and city for B2B outreach - **Market research** — measure business density and average ratings for a category across UK cities - **Directory aggregation** — feed structured UK business data into your own local-search product - **Competitor mapping** — see who else operates in a category and city, with ratings and contact info - **Reputation monitoring** — track a business's rating and review count over time via `mode=byUrl` ### Limitations - **One listing page per city+category search, capped at ~20 businesses.** FreeIndex's server-rendered `-.htm` listing pages show up to 20 businesses each (Premium Members first, then organic listings) with no further query-string pagination exposed. This is a genuine upstream page-size cap, not an actor bug — a category with hundreds of London listings (e.g. `london-plumbers.htm` shows "1,413 Reviews" in its own page title) still only exposes the same top ~20 profile links in the page HTML. To collect more records for one category, run multiple city searches and combine results, or use `mode=byUrl` with a larger list of profile URLs collected across runs. - **Not every city+category combination has a results page.** FreeIndex only pre-generates a `-.htm` page for combinations that have at least one listed business. A real city and a real category can still 404 in combination (e.g. `glasgow-accountants.htm`). When this happens, the actor returns 0 records with a clear `set_status_message` explaining the pair has no results page — try a nearby city or a different category rather than treating it as an error. - **`sortBy`, `minRating`, `minReviews`, and `premiumOnly` are applied client-side** across the batch of records this run actually fetched (up to 20 per search), not the entire category nationwide. - **The `website` field points to whatever the business published on FreeIndex, without an uptime guarantee.** `sourceUrl` and `images[]` are always FreeIndex's own URLs and are 100% reliable. `website` is a third-party business's own domain; occasionally it's expired/unregistered or protected by the business's own bot-blocking WAF (verified via clean-shell `curl` sampling during QA — most resolve fine, a small fraction don't, entirely outside this actor's control). - **`openingHours` reflects what the business itself published.** Some businesses show a generic "00:00-23:59" every day (effectively "hours not specified" rather than "open 24 hours") — this is upstream data, not an actor artifact. ### FAQ **What data source does this actor use?** It reads the publicly available search-listing and business-profile pages on freeindex.co.uk. No account or API key is needed. **Is this affiliated with FreeIndex?** No. This is an independent, third-party actor that reads publicly accessible pages. **Why do some businesses have no rating, phone, or website?** FreeIndex only shows contact/social details a business itself provided, and a rating only once the business has received at least one review. Fields with no data are simply omitted from the record rather than shown as empty or null. **Why is `fetchDetails` on by default?** Business phone number, full address, postcode, coordinates, opening hours, and website are only available on the profile page, not the search-listing card. Turn it off only if you need a faster, listing-only pull (name, locality, rating, review count). **Does this actor need a proxy or login?** No — FreeIndex's search and profile pages are served without any anti-bot challenge, so this actor runs entirely on Apify's free plan with no proxy and no credentials. The actor automatically escalates to Apify's free AUTO proxy group only if it ever encounters a rate limit. **What's the difference between `category` and `customCategory` (or `city` and `customCity`)?** `category`/`city` are curated dropdowns covering FreeIndex's most common categories and UK cities. `customCategory`/`customCity` let you type any FreeIndex category or city slug directly (see the URL of any `-.htm` page on freeindex.co.uk for the exact slug format) and take priority when set. # Actor input Schema ## `mode` (type: `string`): What to fetch: search a category + city, or fetch full business profiles from direct FreeIndex profile URLs. ## `category` (type: `string`): Business category to search for. Pick a common category, or choose 'Custom category' and type your own below (mode=search). ## `customCategory` (type: `string`): 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` (type: `string`): UK city or town to search in. Pick one of the curated cities, or choose 'Custom city' and type your own below (mode=search). ## `customCity` (type: `string`): 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` (type: `boolean`): 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). ## `sortBy` (type: `string`): 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. ## `minRating` (type: `integer`): 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. ## `minReviews` (type: `integer`): Only return businesses with at least this many reviews (mode=search). 0 means no minimum. ## `premiumOnly` (type: `boolean`): Only return businesses flagged as a FreeIndex 'Premium Member' (mode=search). ## `profileUrls` (type: `array`): 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. ## `maxItems` (type: `integer`): 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. ## Actor input object example ```json { "mode": "search", "category": "plumbers", "city": "london", "fetchDetails": true, "sortBy": "relevance", "minRating": 0, "minReviews": 0, "premiumOnly": false, "profileUrls": [], "maxItems": 20 } ``` # Actor output Schema ## `businesses` (type: `string`): Dataset containing all scraped FreeIndex business listings. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "search", "category": "plumbers", "city": "london", "fetchDetails": true, "sortBy": "relevance", "minRating": 0, "minReviews": 0, "premiumOnly": false, "profileUrls": [], "maxItems": 20 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/freeindex-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "search", "category": "plumbers", "city": "london", "fetchDetails": True, "sortBy": "relevance", "minRating": 0, "minReviews": 0, "premiumOnly": False, "profileUrls": [], "maxItems": 20, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/freeindex-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "search", "category": "plumbers", "city": "london", "fetchDetails": true, "sortBy": "relevance", "minRating": 0, "minReviews": 0, "premiumOnly": false, "profileUrls": [], "maxItems": 20 }' | apify call crawlerbros/freeindex-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/freeindex-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "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 } } } } } } } } } } ```