{ "openapi": "3.0.1", "info": { "title": "BBB Scraper: Business Leads, Ratings & New Reviews", "description": "Find businesses on the Better Business Bureau by category and city, with phone, address, BBB rating and accreditation, and get BBB reviews with business replies. Monitor mode returns only new reviews. $1 per 1,000 businesses or reviews; failed searches are free.", "version": "1.0", "x-build-id": "rV3n6ZrUpyl81bZ6x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tenfoldfleet~bbb-scraper-leads-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tenfoldfleet-bbb-scraper-leads-reviews", "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/tenfoldfleet~bbb-scraper-leads-reviews/runs": { "post": { "operationId": "runs-sync-tenfoldfleet-bbb-scraper-leads-reviews", "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/tenfoldfleet~bbb-scraper-leads-reviews/run-sync": { "post": { "operationId": "run-sync-tenfoldfleet-bbb-scraper-leads-reviews", "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": "Categories or keywords", "type": "array", "description": "What to search for on bbb.org, e.g. \"plumber\", \"roofing contractors\", \"dentist\" or a company name. Each term is searched in every location below.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Cities as \"City, ST\" (e.g. \"Austin, TX\"), \"City, Province\" for Canada (e.g. \"Toronto, ON\") or ZIP codes. bbb.org shows at most 225 businesses per search, so for big lists add more cities instead of one large area. Leave empty to search without a location.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "USA", "CAN" ], "type": "string", "description": "USA or Canada.", "default": "USA" }, "maxResultsPerSearch": { "title": "Max businesses per search", "minimum": 1, "maximum": 225, "type": "integer", "description": "Most businesses to save for each term + location pair (bbb.org caps a search at 225). Each saved business is one charged result ($0.001). On the Apify free plan, the $5 monthly credit covers about 5,000 businesses or reviews.", "default": 30 }, "accreditedOnly": { "title": "BBB accredited only", "type": "boolean", "description": "Keep only BBB Accredited Businesses. Skipped businesses are not charged.", "default": false }, "includeReviews": { "title": "Include BBB reviews", "type": "boolean", "description": "Also fetch customer reviews for every business found by the search (one row per review, $0.001 each) and add the review count to each business row.", "default": false }, "profileUrls": { "title": "BBB profile URLs (reviews)", "type": "array", "description": "Business profile links from bbb.org, e.g. https://www.bbb.org/us/oh/cincinnati/profile/plumber/roto-rooter-plumbing-water-cleanup-0292-1922. The Actor returns the reviews for each one. Use it with \"Only new reviews\" to monitor your own business or competitors.", "items": { "type": "string" } }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Newest reviews first. Each review is one charged result ($0.001).", "default": 20 }, "onlyNewReviews": { "title": "Only new reviews (monitor mode)", "type": "boolean", "description": "Return only reviews posted since the previous run with the same monitor name. The first run returns the newest reviews and remembers them. Schedule the Actor daily or weekly to catch new BBB reviews. Turns on review fetching.", "default": false }, "monitorStoreName": { "title": "Monitor name", "type": "string", "description": "Name of the key-value store in your Apify account that keeps the review IDs already seen. Use a different name for each separate monitor.", "default": "bbb-review-monitor" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests to bbb.org. Keep it low to avoid rate limits.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy works for bbb.org. Residential proxy is not needed.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }