Schemas

Community

Public communities people join and post in (subreddits, Facebook groups), with their description, rules, privacy and member count.

Endpoints

4 endpoints return communities on Facebook, Reddit and X.

Schema

Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.

platformstring

Platform ID (reddit, facebook, …).

idstring

Platform-native community ID (string): Reddit's subreddit ID with its t5_ prefix, Facebook's numeric group ID.

namestringnullable

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).

titlestringnullable

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.

descriptionstringnullable

Its short description as plain text; null when it has none.

urlstring uri

Canonical community URL (https://www.reddit.com/r/golang/, https://www.facebook.com/groups/<id>/).

avatar_urlstring urinullable

The community's icon or picture; null when it has none. Platform CDN URLs can expire.

banner_urlstring urinullable

Header or cover image URL; null when it has none.

privacystringnullable

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 ofpublicrestrictedprivate

is_nsfwbooleannullable

Marked adult (NSFW) by the platform; null where the platform has no such mark.

categoriesstring[]

Topics or categories the platform files it under, as shown (not normalized); [] when none.

rulesobject[]

Its published rules, in the platform's order; [] when it has none (listed in unknown_fields when the source cannot see them).

Show 2 child fields

titlestring

The rule's short title (Reddit short_name, Facebook rule_title).

descriptionstringnullable

Its explanation as plain text; null when it has none.

moderatorsobject[]

Accounts that run it (admins and moderators) the platform shows; [] when none are shown (listed in unknown_fields when the source cannot see them).

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

created_atstring date-timenullable

When it was created, RFC 3339 UTC.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

Show 1 child field

member_countintegernullable

Members (on Reddit, subscribers) as the platform counts them.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

Show 3 child fields

facebookobjectnullable

A Facebook group's own fields.

Show 10 child fields

daily_post_countintegernullable

Posts in the group in the last day, as Facebook counts them.

monthly_post_countintegernullable

Posts in the group in the last month, as Facebook counts them.

weekly_new_member_countintegernullable

Members who joined in the last week (parsed from Facebook's text).

admin_countintegernullable

Administrators of the group.

admin_idsstring[]

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).

moderator_countintegernullable

Moderators of the group (not counting its administrators).

is_visiblebooleannullable

True when anyone can find the group in search (Facebook's Visible), false when only members can (Hidden).

history_summarystringnullable

Facebook's summary of the group's history (created, name changes), as shown.

ownerobjectnullable

The Page or account the group is shown as belonging to (Facebook's "Group by ..." on its cover); null when Facebook names none.

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

locationsstring[]

The places the group's admins tie it to, as shown; [] when none.

redditobjectnullable

A subreddit's own fields.

Show 4 child fields

weekly_visitor_countintegernullable

Unique visitors in the last week, as the subreddit's page shows them.

weekly_contribution_countintegernullable

Posts and comments in the last week, as the subreddit's page shows them.

member_nicknamestringnullable

What the subreddit calls its members (gophers on r/golang); null when it has no nickname.

is_quarantinedbooleannullable

True when Reddit has quarantined it (shown only after a warning).

xobjectnullable

An X Community's own fields.

Show 7 child fields

join_policystringnullable

How people join: open (anyone), moderator_approval or admin_approval (a request someone approves), invite_only (by invitation). New values may be added.

One ofopenmoderator_approvaladmin_approvalinvite_only

join_questionstringnullable

The question X asks people who ask to join, as its moderators wrote it; null when it asks none.

invite_policystringnullable

Who can invite people in: members, moderators, admins or none. New values may be added.

One ofmembersmoderatorsadminsnone

creatorobjectnullable

The account that created it (it may have passed to another admin since).

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

moderator_countintegernullable

People who run it, its admin included, as X counts them.

search_tagsstring[]

Words its moderators chose for people to find it by; [] when none (listed in unknown_fields when the source cannot see them).

sample_membersobject[]

The few members X shows on the community's page: a sample chosen by X, not its member list.

Show 6 child fields

idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text ("762.0K members": metrics.member_count). [] when all exact.

unknown_fieldsstring[]

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.

Item errors

Besides the request-level errors every endpoint can return, community endpoints return:

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.
`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.

Example (Facebook)

{
  "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.