{ "openapi": "3.0.1", "info": { "title": "Facebook Groups Scraper", "description": "Facebook Groups Scraper — scrape Facebook groups, including group names, descriptions, member counts, privacy status, categories, URLs, and available metadata for research, audience analysis, and lead generation.", "version": "0.3", "x-build-id": "yi0cHwEK8qQpBpTzL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/socialdataapi~Facebook-Groups-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-socialdataapi-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/socialdataapi~Facebook-Groups-Scraper/runs": { "post": { "operationId": "runs-sync-socialdataapi-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/socialdataapi~Facebook-Groups-Scraper/run-sync": { "post": { "operationId": "run-sync-socialdataapi-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 links, e.g. https://www.facebook.com/groups/cheapmealideas/. A bare group name or numeric group ID works too, and the same group given twice is scraped once. Up to 5 groups are scraped at the same time. Private and deleted groups can't be scraped; they are reported in the run status and produce no rows.", "items": { "type": "string" } }, "resultsLimit": { "title": "🔢 Number of posts to scrape", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of posts to collect in total across all group URLs. Posts are saved page by page as they are found. Free plan: up to 20 posts per run (all groups together) and 200 per month; paid plans can go up to 5000 - Facebook's logged-out feed serves only 3 posts per request, so higher totals would make a single run impractically long.", "default": 20 }, "viewOption": { "title": "🔃 Post sorting", "enum": [ "CHRONOLOGICAL", "RECENT_ACTIVITY", "TOP_POSTS", "CHRONOLOGICAL_LISTINGS" ], "type": "string", "description": "How the group feed is sorted while scraping:\n\n- CHRONOLOGICAL: newest posts by publish date (used when not set)\n- RECENT_ACTIVITY: posts with the latest activity first\n- TOP_POSTS: most engaging posts first\n- CHRONOLOGICAL_LISTINGS: newest listings in Buy/Sell groups\n\nWith a chronological order and a date or year filter, a group stops as soon as its feed reaches older posts.", "default": "CHRONOLOGICAL" }, "searchGroupKeyword": { "title": "🎯 Keyword filter", "type": "string", "description": "Keep only posts whose text contains this word or phrase (not case sensitive). The filter is applied to posts as they are read from the feed; it is not a Facebook search, so a rare word may need many pages before enough posts match.", "default": "" }, "searchGroupYear": { "title": "📅 Publish year filter", "type": "string", "description": "Keep only posts published in this year, e.g. 2025. Can be combined with the keyword filter.", "default": "" }, "onlyPostsNewerThan": { "title": "📅 Posts newer than", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Keep only posts published after this date. Accepts an absolute date (YYYY-MM-DD, e.g. 2025-01-15) or a relative period (7 days, 2 weeks, 1 month, 1 year). With a chronological sort, a group stops once its feed reaches older posts." }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Apify proxy to use for every request. Leave as default (RESIDENTIAL) for the best success rate. Pick other Apify proxy groups or a country to use those instead. Turn Apify proxy off to connect directly; if you also leave custom proxy URLs empty, requests start direct and switch to RESIDENTIAL automatically only after Facebook blocks one. Custom proxy URLs, when given, are used and rotated as provided.", "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 } } } } } } } } } }