---
title: "Get an X community"
method: GET
path: "/x/community"
tags: ["X"]
---

# Get an X community

`GET /x/community`

## Request

- Base URL: `https://api.scrapefield.com/v1`
- URL: `https://api.scrapefield.com/v1/x/community`
- Auth: one of:
  - HTTP bearer
  - none

Fetch one community: its name, description, member_count, created_at, join_policy, rules and creator. `x/posts` with `community_url` gives its posts.

Give exactly one of `url` or `id` to identify the community.

Costs 3 credits, whether the answer is fetched or served from cache. A failed call is refunded automatically.

## Query parameters

- `url` string
- `id` string
- `fresh` boolean
- `demo` boolean

## Response `200`

The request succeeded.

- object
  - `data` XCommunity, required: An X community.
    - `id` string, required: X's id for the community.
    - `url` string, uri, required: The community on X.
    - `name` string, required: The community's name.
    - `description` string, nullable, required: What it is about, in its own words.
    - `member_count` integer, nullable, required: How many members it has.
    - `created_at` string, date-time, nullable, required: When the community was made.
    - `join_policy` string, nullable, required: As X names it: "Open" or "Closed".
    - `rules` object[], required: Its rules, in order.
      - `name` string, required: The rule's title.
      - `description` string, nullable, required: More about the rule. `null` where it has none.
    - `creator_username` string, nullable, required: Who made it.
  - `meta` Meta, required
    - `request_id` string, required: Quote this if you contact support.
    - `credits_charged` integer, required: The endpoint's published cost. 0 for a demo answer, and for a list emptied because everyone in it asked not to be served. A failed call has no `meta`: it answers with an error, and is refunded.
    - `credits_remaining` integer
    - `cached` boolean, required
    - `fetched_at` string, date-time, required: When the data was actually fetched — the original time on a cache hit, so freshness is always visible.
    - `next_cursor` string, nullable, required: Pass as `cursor` for the next page. `null` on the last page. It lasts as long as the answer is cached.
    - `demo` boolean: Present, and true, on a demo answer (`?demo=true` with no key).
    - `note` string: On a demo answer: what it is, and what a live call costs.

## Other responses

- `400`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `401`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `403`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `404`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `429`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `500`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `501`: Something went wrong. `error.code` is stable; `error.message` says what to do next.
- `502`: Something went wrong. `error.code` is stable; `error.message` says what to do next.

---

[API](https://skmtc.dev/scrapefield/apis/scrapefield-api.md) · [All operations](https://skmtc.dev/scrapefield/apis/scrapefield-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapefield/apis/scrapefield-api/revisions/cc5961ac63cf?raw)