{ "openapi": "3.0.1", "info": { "title": "BBB Scraper", "description": "Scrape Better Business Bureau (BBB) business profiles, ratings, complaints, reviews, and accreditation data. Get comprehensive trust signals and reputation data for any business.", "version": "1.0", "x-build-id": "IQxmBhUcDtCtggruk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~bbb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-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/alizarin_refrigerator-owner~bbb-scraper/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-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/alizarin_refrigerator-owner~bbb-scraper/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-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": { "scrapeType": { "title": "Scrape Type", "enum": [ "business_profile", "search", "complaints", "reviews" ], "type": "string", "description": "Type of data to scrape", "default": "business_profile" }, "businessUrl": { "title": "Business URL", "type": "string", "description": "Direct BBB business profile URL (e.g., https://www.bbb.org/us/ca/los-angeles/profile/...)" }, "businessName": { "title": "Business Name", "type": "string", "description": "Business name to search for" }, "location": { "title": "Location", "type": "string", "description": "City and state (e.g., 'Los Angeles, CA')" }, "category": { "title": "Business Category", "type": "string", "description": "Filter by business category" }, "accreditedOnly": { "title": "Accredited Only", "type": "boolean", "description": "Only return BBB accredited businesses", "default": false }, "minRating": { "title": "Minimum Rating", "enum": [ "", "A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F" ], "type": "string", "description": "Minimum BBB rating (A+, A, A-, B+, B, B-, C+, C, C-, D+, D, D-, F)" }, "includeComplaints": { "title": "Include Complaints", "type": "boolean", "description": "Scrape complaint details (increases run time)", "default": true }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Scrape customer reviews", "default": true }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of businesses to scrape", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the scraper" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return sample data without actual scraping (for testing)", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST results when scraping completes (Zapier, Make, n8n, custom endpoint)" }, "webhookPlatform": { "title": "Webhook Platform", "enum": [ "zapier", "make", "n8n", "custom" ], "type": "string", "description": "Platform type for webhook formatting", "default": "custom" }, "webhookHeaders": { "title": "Webhook Custom Headers", "type": "object", "description": "Custom HTTP headers to send with webhook (JSON object)" } } }, "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 } } } } } } } } } }