{ "openapi": "3.0.1", "info": { "title": "Facebook Groups Scraper", "description": "Scrape public Facebook group posts by group URL or group ID. Export post text, author, engagement counts, media URLs, top comments, and pagination cursors.", "version": "0.1", "x-build-id": "lVerxqvnVVgkr4ttU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~facebook-groups-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-facebook-groups-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/khadinakbar~facebook-groups-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-facebook-groups-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/khadinakbar~facebook-groups-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-facebook-groups-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": { "groupUrls": { "title": "Facebook group URLs", "type": "array", "description": "One or more public Facebook group URLs, for example https://www.facebook.com/groups/homemakingtips/.", "items": { "type": "string" } }, "groupIds": { "title": "Facebook group IDs", "type": "array", "description": "Optional numeric Facebook group IDs. Use this when you know the group ID and do not have a URL.", "items": { "type": "string" } }, "maxPosts": { "title": "Maximum posts", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Maximum number of group post records to save across all groups.", "default": 100 }, "maxPagesPerGroup": { "title": "Max provider pages per group", "minimum": 1, "maximum": 200, "type": "integer", "description": "Provider APIs currently return up to 3 posts per request and paginate with a cursor.", "default": 5 }, "startCursor": { "title": "Start cursor", "type": "string", "description": "Optional provider pagination cursor. Use a cursor from RUN_SUMMARY.nextCursors to resume a group feed." }, "sortBy": { "title": "Sort by", "enum": [ "RECENT_ACTIVITY", "TOP_POSTS", "CHRONOLOGICAL", "CHRONOLOGICAL_LISTINGS" ], "type": "string", "description": "Provider-side Facebook group post ordering.", "default": "RECENT_ACTIVITY" }, "dataSource": { "title": "Data source", "enum": [ "auto", "provider", "browser" ], "type": "string", "description": "Auto tries configured providers first, then browser fallback when enabled. Provider only skips browser fallback. Browser only skips provider APIs.", "default": "auto" }, "providerOrder": { "title": "Provider order", "enum": [ "scrapecreators-first", "sociavault-first", "scrapecreators-only", "sociavault-only" ], "type": "string", "description": "Choose which managed provider API is tried first.", "default": "scrapecreators-first" }, "useBrowserFallback": { "title": "Use browser fallback", "type": "boolean", "description": "Try a Playwright browser scrape when provider APIs are unavailable, empty, or disabled.", "default": true }, "maxBrowserScrolls": { "title": "Max browser scrolls", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum page scrolls in browser fallback mode.", "default": 8 }, "facebookCookies": { "title": "Facebook cookies", "type": "string", "description": "Optional JSON cookie array or raw Cookie header for browser fallback only. Use your own authorized session; do not use this for data you are not allowed to access." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for browser fallback.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "includeRawData": { "title": "Include raw provider data", "type": "boolean", "description": "Include raw source objects in each dataset row for debugging and custom downstream parsing.", "default": 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 } } }, "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 } } } } } } } } } }