{ "openapi": "3.0.1", "info": { "title": "Facebook Business Contact Extractor", "description": "Pull public contact details from Facebook business pages at scale: email, phone, website, address, category, price range, services and followers. Feed it a list of pages, or discover them by keyword and country through the Ad Library, since Facebook's page search is closed to logged-out clients.", "version": "0.0", "x-build-id": "oDlyIBKPAog5e1Ipw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~facebook-business-contact-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-facebook-business-contact-extractor", "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/fanndev~facebook-business-contact-extractor/runs": { "post": { "operationId": "runs-sync-fanndev-facebook-business-contact-extractor", "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/fanndev~facebook-business-contact-extractor/run-sync": { "post": { "operationId": "run-sync-fanndev-facebook-business-contact-extractor", "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": { "searchKeywords": { "title": "Discover businesses by keyword", "type": "array", "description": "Find pages instead of listing them. Facebook's own page search is closed to logged-out clients (every /search/ path returns 404), so discovery runs through the Ad Library: it is keyword-addressable and every result names its advertiser. A useful side effect is that the businesses it finds are all currently spending money on ads.", "items": { "type": "string" } }, "countries": { "title": "Countries for discovery", "type": "array", "description": "ISO country codes the Ad Library search runs in. Ignored when you supply pages directly.", "default": [ "US" ], "items": { "type": "string" } }, "pages": { "title": "Pages", "type": "array", "description": "Extract contacts from a list you already have: vanity slugs ('BarbutoNYC') or full Facebook page URLs.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Page URLs, for pasting a list straight out of another actor's dataset.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Caps how many business pages are opened, across both direct input and discovery.", "default": 100 }, "includeTransparency": { "title": "Also read the page transparency tab", "type": "boolean", "description": "Adds the page creation date and whether the business is currently running ads - both useful for qualifying a lead. Costs one extra request per page.", "default": false }, "requireEmail": { "title": "Only businesses with an email", "type": "boolean", "description": "Drop pages that publish no email address.", "default": false }, "requirePhone": { "title": "Only businesses with a phone number", "type": "boolean", "description": "Drop pages that publish no phone number.", "default": false }, "requireWebsite": { "title": "Only businesses with a website", "type": "boolean", "description": "Drop pages that publish no website.", "default": false }, "requireAnyContact": { "title": "Only businesses reachable somehow", "type": "boolean", "description": "Drop pages that publish no email, phone, website or address at all.", "default": false }, "minFollowers": { "title": "Minimum followers", "minimum": 0, "type": "integer", "description": "Pages whose follower count could not be read are dropped too, since an unknown count cannot be shown to clear the bar." }, "categoryContains": { "title": "Category contains", "type": "string", "description": "Case-insensitive substring match against the page's self-declared categories, e.g. 'restaurant', 'dental'." }, "contentLanguages": { "title": "Ad languages for discovery", "type": "array", "description": "Two-letter language codes. Narrows the Ad Library discovery search to ads in these languages.", "default": [], "items": { "type": "string" } }, "concurrency": { "title": "Concurrent page reads", "minimum": 1, "maximum": 10, "type": "integer", "description": "About tabs are large - 8 to 18 MB each - so raising this speeds the run up but costs memory and bandwidth.", "default": 4 }, "emitSummary": { "title": "Add a run summary record", "type": "boolean", "description": "Append one RUN_SUMMARY record: how many pages were read, and how many publish an email, phone, website or address.", "default": true }, "exportFormats": { "title": "Extra export files", "type": "array", "description": "Also write the results to the key-value store in these formats. The dataset is always produced regardless.", "items": { "type": "string", "enum": [ "json", "ndjson", "csv", "xlsx" ], "enumTitles": [ "JSON", "NDJSON", "CSV", "Excel (XLSX)" ] }, "default": [] }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Page about tabs apply no TLS or IP gate and this actor does not paginate through Facebook's GraphQL, so the direct connection works on the Apify platform too. Keyword discovery reads the Ad Library's rendered first page only, which is not rate-limited. Use a proxy to spread a very large run across IPs.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }