---
title: "Search communities"
method: GET
path: "/v1/twitter/communities/search"
tags: ["Communities"]
---

# Search communities

`GET /v1/twitter/communities/search`

## Request

- Base URL: `https://scrapebadger.com`
- URL: `https://scrapebadger.com/v1/twitter/communities/search`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/scrapebadger/apis/scrapebadger-account-api/docs/v1/twitter/communities/search/get.ts> (a function with typed inputs; its response is checked against the schema)

Search for Twitter communities by name, description, or keywords. Returns matching communities with comprehensive information including member count, join policy, and description. Useful for discovering communities related to specific topics.

## Query parameters

- `query` string, required
- `cursor` string

## Response `200`

Successfully retrieved communities.

- CommunitiesResponse: Paginated list of communities.
  - `data` CommunityData[], nullable: Array of community objects.
    - `id` string, required: Unique community identifier.
    - `name` string, required: Name of the community.
    - `description` string, nullable: Description of the community.
    - `member_count` integer, nullable: Number of members.
    - `is_member` boolean, nullable: Whether the authenticated user is a member.
    - `role` 'member' | 'moderator' | 'admin' | 'non_member', nullable: Role of the authenticated user.
    - `is_nsfw` boolean, nullable: Whether the community is marked as NSFW.
    - `join_policy` 'Open' | 'Closed', nullable: Join policy for the community.
    - `invites_policy` string, nullable: Invites policy for the community.
    - `created_at` integer, nullable: Creation timestamp in milliseconds.
    - `created_at_datetime` string, nullable: Creation date in ISO 8601 format.
    - `banner` CommunityBanner: Community banner image information.
      - `url` string, nullable: URL of the banner image.
      - `width` integer, nullable: Width of the banner in pixels.
      - `height` integer, nullable: Height of the banner in pixels.
    - `creator_id` string, nullable: Numeric ID of the community creator.
    - `creator_username` string, nullable: Username of the community creator.
    - `creator_name` string, nullable: Display name of the community creator.
    - `admin_id` string, nullable: Numeric ID of the community admin.
    - `admin_username` string, nullable: Username of the community admin.
    - `admin_name` string, nullable: Display name of the community admin.
    - `rules` CommunityRule[], nullable: Community rules.
      - `name` string, nullable: Name/title of the rule.
      - `description` string, nullable: Detailed description of the rule.
  - `next_cursor` string, nullable: Cursor for fetching the next page. Null if no more results.

## Other responses

- `401`: Authentication failed. The API key is missing, invalid, or expired.
- `402`: Insufficient credits. Your account balance has been exhausted. Purchase more credits at https://scrapebadger.com/dashboard/billing.
- `429`: Rate limit exceeded. Too many requests in a given time period. Implement exponential backoff and retry.

---

[API](https://skmtc.dev/scrapebadger/apis/scrapebadger-account-api.md) - [All operations](https://skmtc.dev/scrapebadger/apis/scrapebadger-account-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrapebadger/apis/scrapebadger-account-api/revisions/4a1ef8777baf?raw)