{ "openapi": "3.0.1", "info": { "title": "Brownbook Business Data Scraper | Real-Time Leads", "description": "Collect live Brownbook business data at scale: search companies by keyword and location, open full profiles with reviews, and enrich leads with emails and socials. Structured rows stream to your dataset in real time.", "version": "0.0", "x-build-id": "T58dXTMGFvJQNihwT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Brownbook-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Brownbook-Real-Time-Data-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/b2b_leads~Brownbook-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Brownbook-Real-Time-Data-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/b2b_leads~Brownbook-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Brownbook-Real-Time-Data-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": { "enableSearch": { "title": "Business search", "type": "boolean", "description": "Find companies on Brownbook by keyword and location — a ready-to-run demo is pre-filled below. NOTE: free Apify plans are limited to a small sample of results per run — upgrade to a paid plan for full, unlimited data.", "default": true }, "searchTasks": { "title": "Search tasks", "type": "array", "description": "One row per search. Add a keyword (what to look for), a city, and a country. Click \"+ Add\" for every additional search. \"Max results\" governs that one row.", "items": { "type": "object", "properties": { "keyword": { "title": "Keyword", "type": "string", "description": "What to look for, e.g. \"plumber\", \"notary\", \"dentist\", \"roofing\", \"coffee shop\".", "editor": "textfield" }, "location": { "title": "City", "type": "string", "description": "City for this search (e.g. \"New York\", \"Houston\", \"London\"). Leave empty to search worldwide.", "editor": "textfield" }, "country": { "title": "Country", "type": "string", "description": "Country for this search (e.g. \"United States\", \"United Kingdom\", \"Canada\", \"Australia\"). Leave empty to search worldwide.", "editor": "textfield" }, "maxResults": { "title": "Max results", "type": "integer", "description": "Maximum rows this one search may return.", "minimum": 1, "prefill": 10, "editor": "number" } }, "required": [ "keyword" ] }, "default": [] }, "enableScrapeByUrl": { "title": "Company URLs", "type": "boolean", "description": "Collect full details for specific Brownbook company pages instead of (or in addition to) searches.", "default": false }, "scrapeUrls": { "title": "Company URLs list", "type": "array", "description": "Brownbook company URLs (https://brownbook.net/business/...).", "default": [], "items": { "type": "string" } }, "enableListingDetails": { "title": "Full company details", "type": "boolean", "description": "Fill each result with its full company profile: description, complete category path, business hours, tags, extra phones and websites, images, and published reviews. Every result is still exported without it — enrichment adds fields to the same row, it never filters or drops rows.", "default": false }, "enableLeadDetails": { "title": "Lead details (email discovery)", "type": "boolean", "description": "Visit each company's own website and add contact emails plus social profiles — the reliable lead-gen option. Works on its own, without full company details, so you can keep runs fast and still get emails. Companies with no published website are still exported, just without contact fields.", "default": false }, "concurrency": { "title": "Details concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "How many detail enrichments run in parallel (1–4). Higher is faster but a bit harder on rate limits.", "default": 2 }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "Every record is always saved to the run's dataset — a webhook is an ADDITIONAL real-time push. When set, each new record is also POSTed to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Apify residential proxy (US) is enabled by default for reliable results.", "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 }, "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 } } } } } } } } } }