{
"openapi": "3.0.1",
"info": {
"title": "BBB Scraper - Business Leads, Ratings & Accreditation",
"description": "Scrape Better Business Bureau businesses by category & city: name, BBB rating (A+ to F), accreditation, phone, full address, website, email, years in business, complaints, customer reviews & owner contacts. US & Canada B2B lead generation. Export JSON, CSV, Excel.",
"version": "1.0",
"x-build-id": "aMdZX4uayd0r5Thqx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~bbb-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~bbb-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-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/scrapesage~bbb-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-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",
"properties": {
"searchTerms": {
"title": "Search terms (category or business name)",
"type": "array",
"description": "What to search for on BBB — a category or keyword such as Plumbers, Roofing Contractors, Auto Repair, HVAC, Lawyers, or a specific business name. Each term is combined with every location below.",
"items": {
"type": "string"
}
},
"locations": {
"title": "Locations (city & state / province)",
"type": "array",
"description": "Where to search — a City, ST string (Austin, TX, Chicago, IL), a ZIP/postal code, or a US state / Canadian province. Each location is combined with every search term. Leave empty to search nationwide for a named business.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Start URLs (optional)",
"type": "array",
"description": "Direct BBB URLs to scrape in addition to searches: search pages (https://www.bbb.org/search?find_text=...&find_loc=...) or business profile pages (https://www.bbb.org/us/.../profile/...). Profile URLs are always fully enriched.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxResults": {
"title": "Max businesses",
"minimum": 0,
"type": "integer",
"description": "Maximum number of businesses to scrape across all searches. Use 0 for no limit (exhaust every search — only with narrow searches).",
"default": 100
},
"maxResultsPerSearch": {
"title": "Max businesses per search",
"minimum": 0,
"type": "integer",
"description": "Optional cap per individual search term + location combination. 0 = no per-search cap (still bounded by Max businesses).",
"default": 0
},
"accreditedOnly": {
"title": "BBB-accredited businesses only",
"type": "boolean",
"description": "Keep only businesses that are BBB Accredited (paying members that meet BBB standards).",
"default": false
},
"minRating": {
"title": "Minimum BBB rating",
"enum": [
"any",
"A+",
"A",
"A-",
"B+",
"B",
"B-",
"C+",
"C",
"C-",
"D+",
"D",
"D-"
],
"type": "string",
"description": "Keep only businesses at or above this BBB letter rating.",
"default": "any"
},
"includeDetails": {
"title": "Scrape full business details",
"type": "boolean",
"description": "Open each business profile for the complete record: website, email, additional phones, years in business, date incorporated, accredited-since, hours, number of employees, owner / principal contacts, BBB file details, complaint count and the full \"About\" overview. Adds one request per business.",
"default": false
},
"includeReviews": {
"title": "Include customer reviews",
"type": "boolean",
"description": "Extract recent BBB customer reviews for each business (author, rating, date, text). Requires business details.",
"default": false
},
"maxReviewsPerBusiness": {
"title": "Max reviews per business",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "How many recent customer reviews to keep per business when \"Include customer reviews\" is on.",
"default": 8
},
"enrichContacts": {
"title": "Enrich emails & socials from business website",
"type": "boolean",
"description": "For businesses that list a website, visit it (home + contact/about, up to 3 pages) and extract public contact emails, phone numbers, a contact-form URL and social profiles (LinkedIn, Instagram, Facebook, Twitter/X, YouTube). Requires business details.",
"default": false
},
"monitorMode": {
"title": "Monitor mode — only output new businesses",
"type": "boolean",
"description": "Remember businesses seen on previous runs (in a named key-value store) and output only businesses that are new or changed (e.g. rating change) since last time. Perfect for scheduled lead pipelines — pair with Apify Schedules to drip only fresh leads into your CRM.",
"default": false
},
"monitorKey": {
"title": "Monitor key",
"type": "string",
"description": "Names the persistent monitor store so you can keep separate watch-lists (e.g. austin-plumbers). Reuse the same key across scheduled runs to keep deduplicating against history.",
"default": "default"
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 12,
"type": "integer",
"description": "How many browser pages to run in parallel. 3–6 is a good balance of speed and reliability; Crawlee auto-scales down if memory is limited.",
"default": 5
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxies to use. US residential proxies are recommended for the highest reliability on BBB profile pages. The default (Apify Residential, US) works out of the box.",
"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
}
}
}
}
}
}
}
}
}
}