{ "openapi": "3.0.1", "info": { "title": "Facebook Search Scraper", "description": "Search public Facebook by keyword and get Pages, people, posts, videos, places and events as clean, ranked rows. Native Facebook search, multi-query, per-query limits. No Facebook login or cookies needed.", "version": "1.0", "x-build-id": "wUJrybovwRJcwwzdk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~facebook-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-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/coregent~facebook-search-scraper/runs": { "post": { "operationId": "runs-sync-coregent-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/coregent~facebook-search-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-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", "required": [ "queries" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "Keywords or phrases to search public Facebook for — a business type and city, a brand, a topic, a person's name. Each query runs on its own and every result row records which query found it. Any language works. Up to 100 queries per run; identical queries run once.", "default": [ "Canberra plumber" ], "items": { "type": "string" } }, "searchType": { "title": "Search type", "enum": [ "pages", "people", "posts", "videos", "places", "events", "top" ], "type": "string", "description": "Which Facebook search tab to read. Pages: business and brand Pages. People: public profiles. Posts: public posts, with reactions, comments and shares. Videos: public videos and Reels (Reels are marked contentType \"reel\"). Places: local businesses and places. Events: public events. Top: Facebook's mixed results (mostly posts, plus Pages and videos) — each row says what it is in rowType. Groups search is not offered: Facebook returns no Groups results to a logged-out visitor.", "default": "pages" }, "maxResults": { "title": "Maximum results per query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most unique results to save for EACH query — two queries at 100 can return up to 200 rows. Facebook often runs out sooner: measured logged-out depth was roughly 30–140 results for Pages and People and 50–100 for Posts and Videos, depending on the query. You are charged only for results actually delivered.", "default": 100 }, "locationUid": { "title": "Location ID (Places and Events only)", "type": "string", "description": "Optional. The numeric Facebook ID of a city, to limit Places or Events results to it — e.g. 106078429431815 for London. The ID is the number at the end of the city's Facebook page URL (facebook.com/pages/London-United-Kingdom/106078429431815). Facebook offers a logged-out location filter for Places and Events only; for other search types the field is ignored with a warning. City NAMES cannot be used: Facebook does not resolve them for logged-out visitors.", "default": "" }, "maxConcurrency": { "title": "Queries in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many queries are searched at the same time. Pages of one query are always read in order. Lower this if you see rate-limit warnings.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy (Datacenter) is on by default. APIFY RESIDENTIAL IS NOT SUPPORTED and the run will fail if you select it: residential bandwidth is billed to the Actor rather than to your run and costs several times what the results are priced at. If you need residential routing, supply your own provider under Custom proxy URLs — that traffic goes through your account.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }