{ "openapi": "3.0.1", "info": { "title": "Facebook B2b Lead Scraper", "description": "Extract targeted business prospects from Facebook using the Facebook B2B Lead Scraper. Collect company pages, descriptions, emails, websites, phone numbers, and follower metrics automatically. Ideal for B2B outreach, lead generation, and market research.", "version": "0.3", "x-build-id": "dprt0wHvI3hQkTT0g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~facebook-b2b-lead-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-facebook-b2b-lead-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/scraper-engine~facebook-b2b-lead-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-facebook-b2b-lead-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/scraper-engine~facebook-b2b-lead-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-facebook-b2b-lead-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "๐Ÿ” Keywords", "type": "array", "description": "๐ŸŽฏ The words that power your B2B lead search! Add one or more industry/trade keywords (e.g. ['marketing agency', 'consulting firm', 'freight forwarder', 'HVAC contractor']) and the actor finds public Facebook **business Pages** matching them, then ๐Ÿ“ง reads the company's own contact email from the Page's public About tab. ๐Ÿ’ก Tip: trade and industry terms ('logistics company', 'law firm') beat generic words โ€” they map to how businesses actually name themselves.", "items": { "type": "string" } }, "platform": { "title": "๐ŸŒ Platform", "enum": [ "Facebook" ], "type": "string", "description": "๐Ÿ“ฑ The social network to mine for leads. Currently locked to Facebook โ€” more platforms coming soon! ๐Ÿš€", "default": "Facebook" }, "location": { "title": "๐Ÿ“ Location Filter", "type": "string", "description": "๐Ÿ—บ๏ธ Optional geo-targeting! Add a city, region or country (e.g. 'London' ๐Ÿ‡ฌ๐Ÿ‡ง, 'New York' ๐Ÿ—ฝ, 'Dubai' ๐Ÿ™๏ธ) to narrow leads down to business Pages mentioning that place. โœจ Leave empty to search the whole globe ๐ŸŒ. โš ๏ธ A very narrow location can cut your result count sharply.", "default": "" }, "emailDomains": { "title": "๐Ÿ“ง Email Domains Filter", "type": "array", "description": "๐ŸŽ›๏ธ Keep only leads whose email sits on the domains you list. ๐Ÿข **Left empty by default on purpose**: genuine B2B contacts are overwhelmingly corporate addresses on the company's *own* domain (info@acme.co.uk, sales@acme.com), so pre-filtering to free webmail would throw away almost every real business lead. ๐Ÿ•ณ๏ธ Empty = collect every domain (recommended for B2B). โœ๏ธ Add entries only when you specifically want them โ€” e.g. ๐Ÿข @yourclient.com, or ๐Ÿ“ฎ @gmail.com ยท ๐Ÿ“จ @outlook.com ยท ๐Ÿ’Œ @hotmail.com ยท ๐Ÿ’œ @yahoo.com if you are deliberately after sole traders on free webmail.", "items": { "type": "string" } }, "maxEmails": { "title": "๐Ÿ“Š Maximum Leads per Keyword", "minimum": 1, "maximum": 5000, "type": "integer", "description": "๐ŸŽš๏ธ How many leads to collect per keyword before moving on. โšก Higher = more leads but longer runs, since every Page's About tab is fetched individually. Default is 20 โœ… (range 1 โ€“ 5,000).", "default": 20 }, "engine": { "title": "โš™๏ธ Engine", "enum": [ "legacy" ], "type": "string", "description": "๐Ÿ”ง The processing engine. Currently 'legacy' ๐Ÿ›ก๏ธ โ€” a reliable, battle-tested extraction pipeline. More engines on the roadmap! ๐Ÿšง", "default": "legacy" }, "enrichFromWebsite": { "title": "๐ŸŒ Enrich from the company website", "type": "boolean", "description": "๐Ÿข When a Facebook business Page lists a website but no email, also fetch that company's own site (home, /contact, /about) and take the corporate mailbox from there. โœ… Recommended โ€” it is where most of the remaining genuine B2B addresses live. โฑ๏ธ Turn off for faster, Facebook-only runs.", "default": true }, "requireBusinessEmail": { "title": "๐Ÿข Corporate domains only", "type": "boolean", "description": "๐ŸŽฏ Drop any lead whose email is on free consumer webmail (Gmail, Outlook, Yahoo, iCloud, โ€ฆ) and keep only addresses on a company's own domain. ๐Ÿ’ผ Turn on for a strictly corporate list; leave off to also capture sole traders and small firms that run on free webmail.", "default": false }, "maxSearchPages": { "title": "๐Ÿ“„ Search depth", "minimum": 1, "maximum": 20, "type": "integer", "description": "๐Ÿ”Ž How many search-result pages to walk per keyword while hunting for business Pages. Higher = more companies discovered, at the cost of a longer run. Default 6 โœ… (range 1 โ€“ 20).", "default": 6 }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy Configuration", "type": "object", "description": "๐ŸŒ Controls the proxy used to fetch Facebook Pages and company websites. ๐Ÿ†“ Leave it as-is and the actor uses the Apify RESIDENTIAL group, which is what makes Facebook serve its logged-out Page markup. ๐Ÿ”Ž Google search always runs through the dedicated GOOGLE_SERP group regardless of this setting โ€” that group can only reach Google's own hosts, so it cannot be used for page fetching. ๐Ÿ”„ On any failed or blocked response the actor rotates to a fresh proxy URL and retries. ๐Ÿง  Advanced users can plug in their own groups or external URLs here." } } }, "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 } } } } } } } } } }