{ "openapi": "3.0.1", "info": { "title": "Facebook Keyword Search Scraper", "description": "Facebook posts scraper by keyword: get text, author, date, reactions, comments, shares and video views from public Facebook posts. No login or cookies. Ideal for brand monitoring and competitor tracking. Pay only for posts you receive.", "version": "0.0", "x-build-id": "yxrgrqdKwbZlFHKzv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datafinch~facebook-keyword-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datafinch-facebook-keyword-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/datafinch~facebook-keyword-search-scraper/runs": { "post": { "operationId": "runs-sync-datafinch-facebook-keyword-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/datafinch~facebook-keyword-search-scraper/run-sync": { "post": { "operationId": "run-sync-datafinch-facebook-keyword-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 keywords", "type": "array", "description": "One or more keywords or phrases to search on Facebook, e.g. a brand, product or topic. Each keyword is searched separately. Up to 100 keywords per run.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Maximum posts per keyword", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit of posts collected for each keyword. The run stops earlier if Facebook shows fewer public posts.", "default": 100 }, "keywordFilter": { "title": "Strict keyword filter", "type": "boolean", "description": "Keep only posts whose text contains the keyword. Off by default, because Facebook also matches hashtags, page names and link previews.", "default": false }, "sortBy": { "title": "Sort results", "enum": [ "relevance", "recent" ], "type": "string", "description": "Most relevant is Facebook's default order. Most recent first is best for monitoring new posts; Facebook then shows about 50-70 of the newest posts per keyword.", "default": "relevance" }, "postedWithin": { "title": "Posted within", "enum": [ "any", "24h", "7d", "30d", "90d", "365d" ], "type": "string", "description": "Keep only posts published in this period. Leave on 'Any time' for no date limit.", "default": "any" }, "postedAfter": { "title": "Posted on or after (date)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional start date, format YYYY-MM-DD (e.g. 2026-10-01). Ignored if 'Posted within' is set." }, "postedBefore": { "title": "Posted on or before (date)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional end date, format YYYY-MM-DD (e.g. 2026-10-31)." }, "searchType": { "title": "Search type", "enum": [ "posts" ], "type": "string", "description": "Type of Facebook results to collect.", "default": "posts" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended. Facebook limits searches from datacenter IPs; if you choose datacenter, the Actor switches to residential automatically when blocked.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxConcurrency": { "title": "Parallel keywords", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many keywords are searched at the same time. 3 is a good default.", "default": 3 } } }, "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 } } } } } } } } } }