{ "openapi": "3.0.1", "info": { "title": "BBB Scraper | Business Leads, Ratings & Phones", "description": "Extract business leads from the Better Business Bureau (BBB): names, ratings, accreditation, phones, addresses and categories. Search many keywords across many cities or ZIP codes in one run, with duplicates removed.", "version": "0.0", "x-build-id": "m189Uj4gv9Veia5lz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piotrv1001~bbb-advanced-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piotrv1001-bbb-advanced-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/piotrv1001~bbb-advanced-scraper/runs": { "post": { "operationId": "runs-sync-piotrv1001-bbb-advanced-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/piotrv1001~bbb-advanced-scraper/run-sync": { "post": { "operationId": "run-sync-piotrv1001-bbb-advanced-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": { "search": { "title": "Search keyword", "type": "string", "description": "Keyword to search for on Better Business Bureau, e.g. Home Improvement. To search several keywords in one run, use \"Additional search keywords\"." }, "searches": { "title": "Additional search keywords", "type": "array", "description": "More keywords to search in the same run, e.g. Roofing, Plumber. Each one is combined with every location.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City and state or ZIP code, e.g. Los Angeles, CA or 90210. Leave empty to search all of BBB (at most 225 businesses per keyword). To search several locations in one run, use \"Additional locations\"." }, "locations": { "title": "Additional locations", "type": "array", "description": "More cities or ZIP codes to search in the same run. BBB returns at most 225 businesses per keyword and location, so split big areas into ZIP codes (with a small distance) to get more leads.", "items": { "type": "string" } }, "startUrls": { "title": "BBB search URLs", "type": "array", "description": "Optional. Paste search result URLs from bbb.org (e.g. https://www.bbb.org/search?find_text=Plumber&find_loc=Austin%2C+TX) to scrape them exactly as filtered on BBB. They run in addition to the keywords above. Business profile pages are not supported here: use the BBB Business Details Scraper for those.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "distance": { "title": "Distance", "minimum": 1, "type": "integer", "description": "Search radius in miles around each location. A small radius (e.g. 5) with many ZIP codes gets past BBB's 225-result limit per search." }, "sort": { "title": "Sort results by", "enum": [ "Distance", "Relevance", "Rating", "AToZ", "ZToA" ], "type": "string", "description": "Order BBB returns results in. Matters most with 'Max results' or when splitting is off, because it decides which businesses come first.", "default": "Distance" }, "country": { "title": "Country", "enum": [ "USA", "CAN" ], "type": "string", "description": "Search only US or only Canadian businesses. Leave empty to search both. Useful when a city name exists in both countries (e.g. London) or for nationwide searches." }, "accreditedOnly": { "title": "BBB Accredited businesses only", "type": "boolean", "description": "Return only BBB Accredited businesses. Off = all businesses, accredited or not.", "default": false }, "minRating": { "title": "Minimum BBB rating", "enum": [ "A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F" ], "type": "string", "description": "Keep only businesses with this BBB letter grade or better. Unrated businesses (NR) are left out. Businesses below the grade are not saved and not charged. Leave empty to keep all." }, "splitLargeSearches": { "title": "Split large searches", "type": "boolean", "description": "BBB shows at most 225 businesses per search. When a search has more matches, split it automatically (by category, alphabetical order, state and accreditation) to collect far more of them. Turn off to get only the first 225 per search.", "default": true }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many businesses in total. Leave empty for no limit (your maximum charge per run still applies). Large searches can return thousands of businesses when splitting is on." } } }, "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 } } } } } } } } } }