{ "openapi": "3.0.1", "info": { "title": "Facebook Search Scraper With WhatsApp & Contact Leads", "description": "Extract public Facebook search results instantly with Facebook Search Scraper. Gather pages, profiles, groups, posts, events, and valuable metadata using keywords for lead generation, competitor tracking, audience insights, and market research.", "version": "0.1", "x-build-id": "beANezs8NRoDECFd8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~facebook-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-facebook-search-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/api-empire~facebook-search-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-facebook-search-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/api-empire~facebook-search-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-facebook-search-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": { "categories": { "title": "🏷️ Categories", "type": "array", "description": "Business types to search (Pub, Bar, Restaurant...). Combined with locations → e.g. \"Pub NYC\", \"Bar London\".", "default": [ "Pub" ], "items": { "type": "string" } }, "locations": { "title": "📍 Locations", "type": "array", "description": "Where to search (NYC, London...) — paired with each category.", "default": [ "NYC" ], "items": { "type": "string" } }, "resultsLimit": { "title": "📊 Results Limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Max pages to scrape across all queries. Higher = more data, longer run.", "default": 10 }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Optional. No proxy by default. Auto fallback to datacenter → residential if blocked." }, "extractWhatsApp": { "title": "💬 Extract WhatsApp", "type": "boolean", "description": "Read the page's WhatsApp business card and emit whatsappNumber, the published whatsappLink, a stable wa.me chat URL and isWhatsappReachable. Measured on 67 live pages: 21% publish one (24% outside the US, 0% on US pages).", "default": true }, "extractLinkedAccounts": { "title": "🔗 Extract Linked Accounts", "type": "boolean", "description": "Emit linkedAccounts (Instagram / TikTok / YouTube / X / LinkedIn / other) and externalLinks[] from the page's linked-account and website cards. Measured 19% of live pages publish at least one linked account.", "default": true }, "requireAnyContact": { "title": "✅ Only Keep Reachable Businesses", "type": "boolean", "description": "Skip any page with no email, no phone and no WhatsApp. Off by default so nothing is dropped silently.", "default": false }, "findWebsiteContactForm": { "title": "🌍 Crawl Business Website For Contacts", "type": "boolean", "description": "Slow, off by default. Fetches the business's own website (and its contact page) and adds websiteContact with emails, phones, socials and a contact-form flag — every value stamped source: website_crawl. Booking and ordering platforms are skipped so their contacts cannot poison your list.", "default": false }, "cookies": { "title": "🍪 Facebook Cookies (optional)", "type": "object", "description": "Optional. Leave empty — every field this actor returns was verified logged-out. Only supply a cookie jar (for example {\"c_user\":\"...\",\"xs\":\"...\"}) if you specifically want your own session used." } } }, "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 } } } } } } } } } }