{ "openapi": "3.0.1", "info": { "title": "Facebook Search Scraper", "description": "Search Facebook for pages and people by keyword. Extract structured data including page/profile details, engagement metrics, and contact information.", "version": "1.0", "x-build-id": "Mwt2o2v6XxCbrAMxV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~facebook-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~facebook-search-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~facebook-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "startUrls": { "title": "Facebook Page URLs", "type": "array", "description": "Direct list of Facebook page URLs to scrape (skips keyword search entirely for these). Accepts full page URLs, e.g. https://www.facebook.com/McDonalds. Can be combined with searchQueries — results from both are merged. Either startUrls or searchQueries is required.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a Facebook page", "description": "URL of a Facebook page to scrape, e.g. https://www.facebook.com/McDonalds" } } } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "List of search keywords to look up on Facebook (e.g., 'coffee shop', 'dentist near me'). Either searchQueries or startUrls is required.", "items": { "type": "string" } }, "searchType": { "title": "Search Type", "enum": [ "pages", "people" ], "type": "string", "description": "Type of Facebook search results to return.", "default": "pages" }, "maxResults": { "title": "Maximum Results (per query or startUrls)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper bound on results per search query (and, separately, for the direct startUrls list) -- not a guarantee. A single keyword query's real yield is capped by DuckDuckGo's own facebook.com index, which is consistently thin: live-tested at ~8-15 results per query even for global brand names like \"starbucks\" and maxResults=5000. Setting this high does not manufacture more matches than DuckDuckGo actually has for that exact query. To reach hundreds or thousands of results in one run: add many diverse searchQueries (each contributes its own ~10-15), or supply that many URLs directly via startUrls (no such ceiling -- proven reliable at 1000+ scale).", "default": 50 }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Fetch and include real reviews (reviewer name, recommend/don't-recommend verdict, review text, date) for each page, when available. Adds one extra request per page.", "default": true }, "addDetail": { "title": "Add Detail (Page Transparency)", "type": "boolean", "description": "Fetch each page's public Page Transparency info -- creation date, whether the Page is currently running ads, and its Page Transparency ID. Off by default because it requires one extra browser page load per result (slower); Facebook does not expose a reliable public 'verified' badge signal at all, so that specific field can't be added regardless of this setting.", "default": false }, "includePosts": { "title": "Include Recent Posts", "type": "boolean", "description": "Fetch recent visible posts from each page's own timeline -- post text, timestamp, permalink, attached photo/video URLs, and reaction/comment/share counts, when publicly visible. Off by default because it requires one extra browser page load per result (slower).", "default": false }, "maxPosts": { "title": "Maximum Posts Per Page", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of recent posts to extract per page when includePosts is on.", "default": 5 }, "cookies": { "title": "Facebook Session Cookies", "type": "string", "description": "Optional Facebook session cookies. Without them, some pages may return a login-wall stub with fewer fields. Accepts EITHER (1) a JSON array of Playwright-style cookie objects, OR (2) a raw `name=value; name2=value2` Cookie header string. Required cookies: c_user, xs, datr, fr, sb. Export them from your logged-in Facebook session via browser DevTools (Application > Cookies > facebook.com)." } } }, "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 } } } } } } } } } }