{ "openapi": "3.0.1", "info": { "title": "Better Business Bureau Scraper", "description": "Scrape Better Business Bureau (BBB.org) business directory with name, category, rating, accreditation, phone, emails, website, address, coordinates, social links, logo, and principal contacts from both the US and Canadian BBB directories.", "version": "2.0", "x-build-id": "kj5nwMofE0ZtEUiBu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~bbb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-bbb-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~bbb-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-bbb-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~bbb-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-bbb-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "string", "description": "What to search for on BBB: a business category (plumber, electrician, roofing, auto repair) or a company name.", "default": "plumber" }, "locations": { "title": "Locations", "type": "array", "description": "Optional cities or postal codes, e.g. 'Chicago, IL', '10001', 'Toronto, ON'. Each is searched separately; businesses found twice are returned once. Leave empty for a country-wide search.", "items": { "type": "string" } }, "countries": { "title": "Country", "enum": [ "US", "CA" ], "type": "string", "description": "BBB directory to search.", "default": "US" }, "maxRecordsGlobal": { "title": "Max businesses (total)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of businesses for the whole run, across all locations.", "default": 3 }, "maxRecordsPerLocation": { "title": "Max businesses per location", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum per location (0 = no per-location limit). BBB shows up to 225 businesses per search, so use several locations for more.", "default": 50 }, "includeDetails": { "title": "Include profile details", "type": "boolean", "description": "Also open each business's BBB profile for website, emails, contacts, dates, hours, licences, social links, reviews and complaints. Turn off for faster runs with search-listing data only.", "default": true }, "includeBranchLocations": { "title": "Include branch locations", "type": "boolean", "description": "BBB lists some businesses once per location (branches, franchises, service addresses). Off: one record per business. On: one record per listed location, each with its own address, phone and coordinates.", "default": false }, "minRating": { "title": "Minimum BBB rating", "enum": [ "any", "A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F" ], "type": "string", "description": "Only businesses rated at least this grade (businesses without a rating are excluded when set).", "default": "any" }, "accreditedOnly": { "title": "BBB Accredited businesses only", "type": "boolean", "description": "Only return BBB Accredited Businesses.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "rating", "distance", "aToZ", "zToA" ], "type": "string", "description": "Order of BBB search results.", "default": "relevance" }, "stateFilter": { "title": "State / province filter", "type": "string", "description": "Optional two-letter state or province code (e.g. IL, ON) to keep results from one state when a search area spans several." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. BBB is fetched directly first; Apify proxies are used automatically only if needed. Choose your own proxy to use it as the fallback, or 'No proxy' to stay direct." } } }, "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 } } } } } } } } } }