{ "openapi": "3.0.1", "info": { "title": "BBB Scraper: Business Ratings, Complaints, Reviews and Phones", "description": "Scrape BBB (Better Business Bureau) businesses by search term and city in the US and Canada: name, BBB rating, accreditation, phone, address, categories, complaint counts, review rating and count. Optional profile details: years in business, website. No login. Pay per business.", "version": "0.1", "x-build-id": "QRoZonx1CNlX7Fb3V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~bbb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~bbb-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-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/themineworks~bbb-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-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": [ "queries" ], "properties": { "queries": { "title": "Search terms", "type": "array", "description": "Business categories or business names to search on BBB, one per line, for example \"plumber\", \"roofing contractors\" or \"Roto-Rooter\". Each term is one search.", "default": [ "plumber" ], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Where to search: a city and state (\"Austin, TX\"), a ZIP code (\"78701\"), or a Canadian city and province (\"Toronto, ON\") or postal code. Leave empty to search all of BBB (US and Canada). A state on its own is read by BBB as one city in it.", "default": "" }, "maxResults": { "title": "Max results per search", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Most businesses to return for each search term (and each search link), 10 to 1,000. BBB shows 225 businesses per search order; for bigger searches the actor also reads BBB's other views of the same search (A to Z, Z to A, by rating grade, accredited only), which reached 999 of 2,545 plumbers in Austin in our test. For full coverage of a big area, run it per ZIP code or city.", "default": 10 }, "accreditedOnly": { "title": "BBB Accredited businesses only", "type": "boolean", "description": "Return only businesses that are BBB Accredited.", "default": false }, "includeComplaintsAndReviews": { "title": "Add complaint counts and customer reviews", "type": "boolean", "description": "For each business, add its BBB complaint counts (total over the last 3 years, last 12 months, by status and by type) and its customer review count and average star rating. No extra charge; turn off for a faster run with the search card fields only.", "default": true }, "includeDetails": { "title": "Add profile page details (charged extra)", "type": "boolean", "description": "Also read each business's BBB profile page for years in business, business start date, accredited since, website, other phones and websites, business email when listed, type of entity, description, licences and rating reasons. Each row that gets these details is charged one profile-details event on top of the business row.", "default": false }, "startUrls": { "title": "BBB links", "type": "array", "description": "Optional. BBB search links (https://www.bbb.org/search?find_text=plumber&find_loc=Austin%2C%20TX, filters and sort kept), category links (https://www.bbb.org/us/tx/austin/category/plumber) or business profile links (https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803). When links are given, the search terms above are not run.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }