# Facebook Group API Facebook Returns a Facebook group's about page from its link or ID: exact member count, description, privacy, rules, posting activity and who runs it. It also has the name and vanity name, cover photo and picture, whether the group shows in search, its topics and location, when it was created and its name changes, each admin's and moderator's name, picture and profile link, and the Page it belongs to. Private groups answer too, with what their page shows logged out. GET `/v1/facebook/group` ## Example cURL: ```shell curl -G 'https://socialtap.dev/v1/facebook/group' \ --data-urlencode 'url=https://www.facebook.com/groups/366190054572553/' \ -H "x-api-key: $SOCIALTAP_API_KEY" ``` TypeScript SDK: ```typescript import { SocialTap } from "socialtap"; const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY const res = await client.facebook.group.get({ url: "https://www.facebook.com/groups/366190054572553/" }); console.log(res.data); console.log(res.credits.charged, res.meta.request_id); ``` Node.js (fetch): ```javascript const params = new URLSearchParams({ url: "https://www.facebook.com/groups/366190054572553/", }); const res = await fetch(`https://socialtap.dev/v1/facebook/group?${params}`, { headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" }, }); const body = await res.json(); if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`); const { data, meta } = body; console.log(data, meta.credits_charged); ``` Python (requests): ```python import os import requests res = requests.get( "https://socialtap.dev/v1/facebook/group", params={"url": "https://www.facebook.com/groups/366190054572553/"}, headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]}, ) body = res.json() if not res.ok: raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}") data, meta = body["data"], body["meta"] print(data, meta["credits_charged"]) ``` Go (net/http): ```go package main import ( "encoding/json" "fmt" "log" "net/http" "net/url" "os" ) func main() { q := url.Values{} q.Set("url", "https://www.facebook.com/groups/366190054572553/") req, err := http.NewRequest("GET", "https://socialtap.dev/v1/facebook/group?"+q.Encode(), nil) if err != nil { log.Fatal(err) } req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { log.Fatal(err) } defer res.Body.Close() var body struct { Data json.RawMessage `json:"data"` Meta map[string]any `json:"meta"` Error *struct { Code string `json:"code"` Message string `json:"message"` } `json:"error"` } if err := json.NewDecoder(res.Body).Decode(&body); err != nil { log.Fatal(err) } if body.Error != nil { log.Fatalf("%s: %s", body.Error.Code, body.Error.Message) } fmt.Println(string(body.Data), body.Meta["credits_charged"]) } ``` 200 OK: ```json { "data": { "approximate_fields": [], "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t1.6435-9/121615771_3201454343306997_2348901429098757975_n.jpg?stp=c120.0.400.400a_cp0_dst-jpg_tt6&cstp=mx400x400&ctp=s110x80&_nc_cat=106&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=23&_nc_ht=scontent-atl3-1.xx&_nc_…", "banner_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t1.6435-9/121615771_3201454343306997_2348901429098757975_n.jpg?stp=dst-jpg_tt6&cstp=mx640x400&ctp=s640x400&_nc_cat=106&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=23&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc_ss…", "categories": [ "Software & tech", "Engineering" ], "created_at": "2020-10-14T11:05:03Z", "description": "Let's share our knowledge on Python Programming", "id": "366190054572553", "is_nsfw": null, "metrics": { "member_count": 763182 }, "moderators": [ { "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/297738489_149183324449711_6655284279259187616_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx720x730&ctp=p64x64&_nc_cat=106&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_nc…", "display_name": "Nusrat Jahan", "id": "pfbid06GnASXZiYzDf35bsZJ3QLiKd5swrdR2gbc9txBtTEAZvJz1oW5bg7n1zMF1wzFJul", "is_verified": null, "url": "https://www.facebook.com/people/Nusrat-Jahan/pfbid06GnASXZiYzDf35bsZJ3QLiKd5swrdR2gbc9txBtTEAZvJz1oW5bg7n1zMF1wzFJul/", "username": null }, { "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/242977119_109642788145497_5023972278328162431_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx1200x1200&ctp=s64x64&_nc_cat=110&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED&_…", "display_name": "Thesoftwarelion", "id": "100079525026696", "is_verified": null, "url": "https://www.facebook.com/profile.php?id=100079525026696", "username": null }, { "avatar_url": "https://scontent-atl3-1.xx.fbcdn.net/v/t39.30808-1/795255518_27959759933716428_4332290339331851799_n.jpg?stp=cp0_dst-jpg_tt6&cstp=mx1568x1556&ctp=s64x64&_nc_cat=110&ccb=SCRUBBED&_nc_sid=SCRUBBED&_nc_ohc=SCRUBBED&_nc_oc=SCRUBBED&_nc_zt=24&_nc_ht=scontent-atl3-1.xx&_nc_gid=SCRUBBED…", "display_name": "Jamil Ahmed", "id": "pfbid02tVzjeEoXMnLspija9MeZZfBPwsH4T5796pNLJhq8jhk2QZ8EThUdgbsDi7uPqFMXl", "is_verified": null, "url": "https://www.facebook.com/people/Jamil-Ahmed/pfbid02tVzjeEoXMnLspija9MeZZfBPwsH4T5796pNLJhq8jhk2QZ8EThUdgbsDi7uPqFMXl/", "username": null } ], "name": null, "platform": "facebook", "platform_specific": { "facebook": { "admin_count": 3, "admin_ids": [ "pfbid06GnASXZiYzDf35bsZJ3QLiKd5swrdR2gbc9txBtTEAZvJz1oW5bg7n1zMF1wzFJul", "100079525026696", "pfbid02tVzjeEoXMnLspija9MeZZfBPwsH4T5796pNLJhq8jhk2QZ8EThUdgbsDi7uPqFMXl" ], "daily_post_count": 21, "history_summary": "Group created on October 14, 2020. Name last changed on October 16, 2020.", "is_visible": true, "locations": [], "moderator_count": 0, "monthly_post_count": 1641, "owner": null, "weekly_new_member_count": null } }, "privacy": "public", "rules": [ { "description": "We're all in this together to create a welcoming environment. Let's treat everyone with respect. Healthy debates are natural, but kindness is required.", "title": "Be Kind and Courteous" }, { "description": "Make sure everyone feels safe. Bullying of any kind isn't allowed, and degrading comments about things like race, religion, culture, sexual orientation, gender or identity will not be tolerated.", "title": "No Hate Speech or Bullying" }, { "description": "Give more than you take to this group. Self-promotion, spam and irrelevant links aren't allowed.", "title": "No Promotions or Spam" } ], "title": "Python Programming", "unknown_fields": [], "url": "https://www.facebook.com/groups/366190054572553/" }, "meta": { "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f", "platform": "facebook", "source": "page", "is_cached": false, "credits_charged": 1, "latency_ms": 1564, "fetched_at": "2026-10-25T12:00:00Z", "input": { "kind": "community", "id": "366190054572553", "url": "https://www.facebook.com/groups/366190054572553/" }, "credits_remaining": 9999, "client_request_id": null, "warnings": [] } } ``` Long arrays and strings are shortened for display; real responses are complete. > [!NOTE] > > **Good to know** > > - A private group returns what its page shows logged out: description, rules and activity, but not who runs it (moderators is empty and listed in unknown_fields, admin_count and moderator_count null). Its posts are for members only. > - moderators lists the admins first, then the moderators, as many of each as Facebook shows. platform_specific.facebook.admin_ids names the admins among them, and admin_count and moderator_count count them all. > - A link Facebook shows nothing for (an unknown name, a hidden or removed group) returns private_or_unavailable, without saying which. > - weekly_new_member_count is null when Facebook's page says no one joined, which it says of every group logged out, growing ones too. > - Facebook groups have no adult label, so is_nsfw is always null. ## Authorizations `x-api-key`stringheaderrequired Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md) ## Query parameters | Name | Type | Description | Example | | --- | --- | --- | --- | | `url` required | `string`
max 2,048 chars | The group: its link (facebook.com/groups/\, any tab of it, on any facebook.com host; the legacy group.php?gid=\), its share link (facebook.com/share/g/\) or its bare numeric ID. | `https://www.facebook.com/groups/366190054572553/` | `url` takes Facebook community links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)). **Parameters every endpoint accepts** | Name | Type | Description | Example | | --- | --- | --- | --- | | `max_age` optional | `integer`
min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — | | `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — | ## Response ### 200 `{data, meta}`. `data` is a [community](https://socialtap.dev/resources/community/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Facebook has are under `platform_specific.facebook`. | Field | Type | Description | | --- | --- | --- | | `data.platform` | `string` | Platform ID (reddit, facebook, …). | | `data.id` | `string` | Platform-native community ID (string): Reddit's subreddit ID with its t5_ prefix, Facebook's numeric group ID. | | `data.name` | `string` or `null` | The name its links use, without a prefix (golang for r/golang; a Facebook group's vanity name); null when it has none (a Facebook group known only by its number). | | `data.title` | `string` or `null` | The community's title as its page shows it ("The Go Programming Language"; what Facebook calls a group's name); null when it has none. | | `data.description` | `string` or `null` | Its short description as plain text; null when it has none. | | `data.url` | `string` (uri) | Canonical community URL (https://www.reddit.com/r/golang/, https://www.facebook.com/groups/\/). | | `data.avatar_url` | `string` (uri) or `null` | The community's icon or picture; null when it has none. Platform CDN URLs can expire. | | `data.banner_url` | `string` (uri) or `null` | Header or cover image URL; null when it has none. | | `data.privacy` | `string` or `null` | public: anyone can see its posts and any member can post; restricted: anyone can see its posts, only approved members can post; private: only members can see its posts (a private community answers private_or_unavailable unless its page shows these fields logged out). New values may be added; treat unknown values as restricted.
One of `public`, `restricted`, `private` | | `data.is_nsfw` | `boolean` or `null` | Marked adult (NSFW) by the platform; null where the platform has no such mark. | | `data.categories` | `string[]` | Topics or categories the platform files it under, as shown (not normalized); \[\] when none. | | `data.rules` | `object[]` | Its published rules, in the platform's order; \[\] when it has none (listed in unknown_fields when the source cannot see them). | | `data.rules[].title` | `string` | The rule's short title (Reddit short_name, Facebook rule_title). | | `data.rules[].description` | `string` or `null` | Its explanation as plain text; null when it has none. | | `data.moderators` | `object[]` | Accounts that run it (admins and moderators) the platform shows; \[\] when none are shown (listed in unknown_fields when the source cannot see them). | | `data.moderators[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. | | `data.moderators[].username` | `string` or `null` | Handle without the @; null when the account has none. | | `data.moderators[].display_name` | `string` or `null` | Display name shown on the profile. | | `data.moderators[].url` | `string` (uri) or `null` | Canonical profile URL. | | `data.moderators[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. | | `data.moderators[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. | | `data.created_at` | `string` (date-time) or `null` | When it was created, RFC 3339 UTC. | | `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. | | `data.metrics.member_count` | `integer` or `null` | Members (on Reddit, subscribers) as the platform counts them. | | `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\); each null when unknown. | | `data.platform_specific.facebook` | `object` or `null` | A Facebook group's own fields. | | `data.platform_specific.facebook.daily_post_count` | `integer` or `null` | Posts in the group in the last day, as Facebook counts them. | | `data.platform_specific.facebook.monthly_post_count` | `integer` or `null` | Posts in the group in the last month, as Facebook counts them. | | `data.platform_specific.facebook.weekly_new_member_count` | `integer` or `null` | Members who joined in the last week (parsed from Facebook's text). | | `data.platform_specific.facebook.admin_count` | `integer` or `null` | Administrators of the group. | | `data.platform_specific.facebook.admin_ids` | `string[]` | The IDs of the administrators among moderators (the rest are its moderators), as far as Facebook shows them; \[\] when none are shown (listed in unknown_fields when the source cannot see them). | | `data.platform_specific.facebook.moderator_count` | `integer` or `null` | Moderators of the group (not counting its administrators). | | `data.platform_specific.facebook.is_visible` | `boolean` or `null` | True when anyone can find the group in search (Facebook's Visible), false when only members can (Hidden). | | `data.platform_specific.facebook.history_summary` | `string` or `null` | Facebook's summary of the group's history (created, name changes), as shown. | | `data.platform_specific.facebook.owner` | `object` or `null` | The Page or account the group is shown as belonging to (Facebook's "Group by ..." on its cover); null when Facebook names none. | | `data.platform_specific.facebook.owner.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. | | `data.platform_specific.facebook.owner.username` | `string` or `null` | Handle without the @; null when the account has none. | | `data.platform_specific.facebook.owner.display_name` | `string` or `null` | Display name shown on the profile. | | `data.platform_specific.facebook.owner.url` | `string` (uri) or `null` | Canonical profile URL. | | `data.platform_specific.facebook.owner.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. | | `data.platform_specific.facebook.owner.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. | | `data.platform_specific.facebook.locations` | `string[]` | The places the group's admins tie it to, as shown; \[\] when none. | | `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text ("762.0K members": metrics.member_count). \[\] when all exact. | | `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. | not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned. ### 400 400 Bad Request: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. | ### 401 401 Unauthorized: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. | ### 402 402 Payment Required: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. | | `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. | ### 403 403 Forbidden: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. | | `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. | ### 404 404 Not Found: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. | ### 429 429 Too Many Requests: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. | ### 500 500 Internal Error: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. | ### 502 502 Bad Gateway: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. | ### 503 503 Unavailable: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. | | `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. | ## Pricing From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Public page → Platform API. | Source | Price per successful request | Per 1,000 requests | | --- | --- | --- | | Any source | 1 credit | $0.75–$1.97 | **Balance, sources and what you were charged** Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts. | meta.source | Source | What it means | | --- | --- | --- | | `page` | Public page | Data embedded in the platform's public web page. | | `api` | Platform API | The platform's public, logged-out API. | `meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md) Endpoint ID `facebook.group` · operationId `facebook.group.get` · [Product overview](https://socialtap.dev/apis/facebook/group/index.md) --- [HTML version](https://socialtap.dev/docs/reference/facebook/group/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)