{ "openapi": "3.0.1", "info": { "title": "Facebook post scraper - Groups, Pages, Search", "description": "Scrape posts from facebook from various sources such as groups, profiles, pages and search results. Get complete details such as author details, post text, attachments, engagement details, etc", "version": "1.1", "x-build-id": "5vhPfDeTHMPg1bNkK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/curious_coder~facebook-post-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-curious_coder-facebook-post-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/curious_coder~facebook-post-scraper/runs": { "post": { "operationId": "runs-sync-curious_coder-facebook-post-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/curious_coder~facebook-post-scraper/run-sync": { "post": { "operationId": "run-sync-curious_coder-facebook-post-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": [ "urls" ], "properties": { "urls": { "title": "Group, page/profile, or search URL(s) to scrape posts from", "type": "array", "description": "Facebook group URLs (e.g. https://www.facebook.com/groups/hackgrowth), page/profile URLs (e.g. https://www.facebook.com/ZapierApp/, https://www.facebook.com/username/, or https://www.facebook.com/profile.php?id=123456), or search URLs (e.g. https://www.facebook.com/search/top?q=web%20scraping). Search URLs require cookies.", "items": { "type": "string" } }, "scrapePhotos": { "title": "📷 Scrape all photos from posts", "type": "boolean", "description": "When enabled, scrapes all full-resolution photos from each post using Facebook's photo viewer API. This traverses the entire photo set, including photos not shown in the feed preview. Adds an 'all_photos' array to each post with URLs, dimensions, and captions.", "default": false }, "sortType": { "title": "Sort type", "enum": [ "most_relevant", "recent_activity", "new_posts" ], "type": "string", "description": "", "default": "new_posts" }, "scrapeUntil": { "title": "Scrape until date", "type": "string", "description": "Use this field if you want to only scrape posts newer than given date" }, "count": { "title": "#️⃣ Total number of records required", "type": "integer", "description": "Leave this field empty if you want to scrape all items." }, "cursors": { "title": "Start from cursors", "type": "array", "description": "Array of cursors to resume scraping, in the same order as urls (1st cursor for 1st URL, etc.). Use the cursors stored in the key-value store from a previous run to continue from where you left off.", "items": { "type": "string" }, "default": [] }, "outputFormat": { "title": "Output format", "enum": [ "raw", "simple" ], "type": "string", "description": "Choose 'raw' for complete nested Facebook data, or 'simple' for a clean flat structure with max 3 levels depth", "default": "raw" }, "cookie": { "title": "🍪 Cookies", "type": "array", "description": "Cookie used to authorize actor with facebook.com. Install [Cookie-Editor](https://chromewebstore.google.com/detail/cookie-editor/hlkenndednhfkekhgcdicdfddnkalmdm) chrome extension. Login to your facebook.com account. Click on the extension and export the facebook.com cookies. Insert the contents here" }, "minDelay": { "title": "⏱️ Minimum wait duration", "minimum": 1, "type": "integer", "description": "Minimum duration in seconds to wait before scraping next page", "default": 1 }, "maxDelay": { "title": "⏱️ Maximum wait duration", "minimum": 10, "type": "integer", "description": "Maximum duration in seconds to wait before scraping next page", "default": 10 }, "proxy": { "title": "Proxy", "type": "object", "description": "If using cookies, Choose a proxy from the country where you are logged into Facebook" } } }, "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 } } } } } } } } } }