{ "openapi": "3.0.1", "info": { "title": "BBB Business Directory Scraper", "description": "Scrape business listings from the Better Business Bureau (bbb.org) in bulk: name, category, full address, phone, geo, BBB letter rating and accreditation status. Search by category and location across the US, Canada and Mexico. Build local B2B lead lists and directories.", "version": "0.1", "x-build-id": "yjVHiZWRfsVjf3q3O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeworks~bbb-business-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeworks-bbb-business-directory-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/scrapeworks~bbb-business-directory-scraper/runs": { "post": { "operationId": "runs-sync-scrapeworks-bbb-business-directory-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/scrapeworks~bbb-business-directory-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeworks-bbb-business-directory-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": { "searchTerms": { "title": "Search terms (category or business name)", "uniqueItems": true, "type": "array", "description": "One or more things to search for on bbb.org - a business category like 'plumber', 'roofing contractor', 'hvac', 'auto repair', or a specific company name. Every search term is run against every location below (so 5 terms x 4 locations = 20 searches), and each search is paginated deep. Results are billed per business row, so more terms = more rows.", "items": { "type": "string" } }, "locations": { "title": "Locations", "uniqueItems": true, "type": "array", "description": "Locations to search in - 'City, ST' (e.g. 'New York, NY'), a state, or a ZIP code. Each search term is searched in each location. Leave empty to search each term nationally (a location narrows results and is recommended for category searches). The BBB caps a single location search at about 225 businesses, so use several locations to pull a whole region.", "items": { "type": "string" } }, "searchUrls": { "title": "BBB search URLs (optional, power users)", "uniqueItems": true, "type": "array", "description": "Optional: paste full bbb.org search-results URLs (e.g. 'https://www.bbb.org/search?find_country=USA&find_text=plumber&find_loc=New%20York%2C%20NY') with your own filters already applied. Each URL is scraped and paginated deep, just like a term+location pair. Use this when you want BBB's own advanced filters; otherwise just use Search terms + Locations.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "USA", "CAN", "MEX" ], "type": "string", "description": "Country to search within. USA = United States, CAN = Canada, MEX = Mexico. Applied to the Search terms + Locations searches (not to pasted Search URLs, which carry their own country).", "default": "USA" }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum businesses to return for EACH term+location pair (and each pasted URL). The actor paginates automatically (15 businesses per page). The BBB itself caps a single search at about 225 results, so a value of 225 pulls everything available for that search.", "default": 225 }, "accreditedOnly": { "title": "BBB-accredited businesses only", "type": "boolean", "description": "If enabled, only businesses that are BBB Accredited are returned (and billed). Leave off to get every business the directory lists, accredited or not.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to reach bbb.org. The default (Apify Residential proxy, US) is recommended - the site's CDN can throttle datacenter traffic at volume. The actor automatically rotates to a fresh proxy session if a page is blocked.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }