{ "openapi": "3.0.1", "info": { "title": "BBB Scraper - Ratings, Reviews, Complaints & Business Profiles", "description": "BBB scraper for US and Canadian businesses: letter grade, accreditation and date, address, phone, website, star rating and review count, plus optional customer reviews and complaints with business responses. For reputation monitoring, contractor leads and due diligence.", "version": "0.1", "x-build-id": "s24VjjyjZBvEjhOXs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~bbb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~bbb-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~bbb-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": { "search_terms": { "title": "Search terms", "type": "array", "description": "Business names, categories or keywords. Requires location; each term starts a separate search.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City and state or province, for example Denver, CO or Toronto, ON. Required with search_terms." }, "country": { "title": "Country", "enum": [ "USA", "CAN" ], "type": "string", "description": "Country for searches built from search_terms.", "default": "USA" }, "search_urls": { "title": "Search urls", "type": "array", "description": "BBB search or category URLs. Existing filters and the starting page are preserved.", "items": { "type": "string" } }, "profile_urls": { "title": "Profile urls", "type": "array", "description": "BBB business profile URLs. Customer-review, complaint and addressId suffixes are normalised to the profile.", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "Relevance", "Rating", "Distance", "AToZ", "ZToA" ], "type": "string", "description": "Sort order for searches built from search_terms.", "default": "Relevance" }, "accredited_only": { "title": "Accredited only", "type": "boolean", "description": "Require accreditation in searches built from search_terms.", "default": false }, "limit": { "title": "Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum businesses across all inputs. Review and complaint rows do not consume this limit.", "default": 50 }, "include_details": { "title": "Include details", "type": "boolean", "description": "Fetch full profiles for search results. Off returns search cards with null website, stars, review count and accreditation date. Direct profile URLs always return details.", "default": true }, "include_reviews": { "title": "Include reviews", "type": "boolean", "description": "Deliver customer reviews as separate rows linked to each business.", "default": false }, "max_reviews": { "title": "Max reviews", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum reviews per business, newest first. Zero disables review collection.", "default": 20 }, "include_complaints": { "title": "Include complaints", "type": "boolean", "description": "Deliver public complaints as separate review rows with review_type complaint.", "default": false }, "max_complaints": { "title": "Max complaints", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum public complaints per business. Zero disables complaint collection.", "default": 20 }, "cursor": { "title": "Continuation cursor (advanced)", "maxLength": 2000000, "type": "string", "description": "Opaque signed continuation token. Resubmit the same inputs with this token to continue; null starts a new collection." } } }, "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 } } } } } } } } } }