{ "openapi": "3.0.1", "info": { "title": "Facebook Groups Scraper", "description": "Scrape public Facebook Groups: posts, authors, timestamps, reactions with a per-reaction breakdown, comment and share counts, photos, videos, links and group details. Many groups per run, a per-group limit, date cutoff and Facebook's Newest/Top feeds. Private groups are reported, never accessed.", "version": "1.0", "x-build-id": "xgxRNRfBywvMKIps8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~facebook-groups-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-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/coregent~facebook-groups-scraper/runs": { "post": { "operationId": "runs-sync-coregent-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/coregent~facebook-groups-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Facebook Group URLs", "type": "array", "description": "One or more PUBLIC Facebook Group URLs, e.g. https://www.facebook.com/groups/{group}. Slugs and numeric IDs both work, on www., web. and m.facebook.com; tracking parameters and trailing paths such as /about are ignored. Private or member-only groups are not supported and are reported as PRIVATE_OR_LOGIN_REQUIRED. Page, profile and single-post URLs are rejected with a reason.", "default": [ { "url": "https://www.facebook.com/groups/javascript.developers/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "resultsLimit": { "title": "Maximum posts per group", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of posts to save PER GROUP — not across the whole run. Up to about 50 come back in the first request; beyond that Facebook serves 3 posts per page, so large limits take proportionally longer. You are charged only for posts you receive.", "default": 100 }, "sort": { "title": "Sort", "enum": [ "NEWEST", "TOP" ], "type": "string", "description": "Which Facebook group feed to read. 'Newest' is Facebook's own chronological group feed. 'Top' is Facebook's default ranked feed, which lifts a few older high-engagement posts to the top. Both are Facebook's ordering, not a re-sort by this Actor. 'Recent activity' is not offered: logged out it returned exactly the 'Top' order, so it could not be shown to work.", "default": "NEWEST" }, "postsNewerThan": { "title": "Posts newer than", "type": "string", "description": "Only return posts published after this point. A date (2026-10-01 or 2026-10-01T00:00:00Z) or a period counted back from now: 24 hours, 7 days, 2 weeks, 3 months, 1 year. With 'Newest' the Actor stops reading a group as soon as it passes the cutoff instead of fetching old posts to throw away.", "default": "" }, "includeGroupDetails": { "title": "Include group details", "type": "boolean", "description": "Add the group's public description, member-count text, cover image and locations to every row's `group` object. Group ID, name, slug, URL, privacy and member count are always included. Free either way.", "default": true }, "includeTopComments": { "title": "Include top-comment preview", "type": "boolean", "description": "Add the few top comments Facebook already ships with each post in the group feed (text, commenter, time, reply count). No extra requests and no extra charge. This is a preview, not the full thread — for every comment and reply, pass the returned postUrl values to coregent/facebook-comments-scraper.", "default": false }, "minReactions": { "title": "Minimum reactions", "minimum": 0, "type": "integer", "description": "Only return posts with at least this many reactions. 0 = no filter. A post whose count Facebook did not publish is kept, not dropped. Filtered-out posts are never charged.", "default": 0 }, "minComments": { "title": "Minimum comments", "minimum": 0, "type": "integer", "description": "Only return posts with at least this many comments. 0 = no filter. Filtered-out posts are never charged.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify RESIDENTIAL proxy is used by default, and its bandwidth is included in the per-post price — you pay nothing extra for it. Facebook refuses public groups to datacenter addresses (measured: the group page redirects to login), so a datacenter or no-proxy setting is switched to residential automatically. To use your own provider instead, supply Custom proxy URLs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }