> ## Documentation Index
> Fetch the complete documentation index at: https://x-preview-mintlify-508d47e7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# X API Overview

> Complete X API v2 reference covering Posts, users, Spaces, Direct Messages, lists, trends, media, compliance, streaming, and webhook endpoints.

export const Button = ({href, children}) => {
  return <div className="not-prose">
    <a href={href}>
      <button className="x-btn">
        <span>{children}</span>
        <svg width="3" height="24" viewBox="0 -9 3 24" class="h-6 rotate-0 overflow-visible"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg>
      </button>
    </a>
  </div>;
};

The X API gives you programmatic access to X's public conversation. All endpoints below are available on [pay-per-use](/x-api/introduction) plans. Endpoints marked as Enterprise-only require an [Enterprise](/enterprise-api/introduction) plan.

***

## Endpoints

<CardGroup cols={3}>
  <Card title="Posts" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/yrNbfyssZy5Znz8E/icons/xds/icon-chat.svg?fit=max&auto=format&n=yrNbfyssZy5Znz8E&q=85&s=113c0d7b51cc7e67a9177dd7c7465001" href="/x-api/posts/lookup/introduction" width="24" height="24" data-path="icons/xds/icon-chat.svg">
    Search, retrieve, and publish posts. Access timelines, threads, and quote posts.
  </Card>

  <Card title="Users" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/HDrVUjgtXXVEkFXv/icons/xds/icon-person.svg?fit=max&auto=format&n=HDrVUjgtXXVEkFXv&q=85&s=67c45a4720ebd067938344fe3fb657cb" href="/x-api/users/lookup/introduction" width="24" height="24" data-path="icons/xds/icon-person.svg">
    Look up profiles, manage follows, blocks, and mutes.
  </Card>

  <Card title="Direct Messages" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/8F4a3JZSzxaWjcbM/icons/xds/icon-envelope.svg?fit=max&auto=format&n=8F4a3JZSzxaWjcbM&q=85&s=725496c2c2efb78fa7f2cf4a451376f5" href="/x-api/direct-messages/lookup/introduction" width="24" height="24" data-path="icons/xds/icon-envelope.svg">
    Send and receive private messages.
  </Card>

  <Card title="Spaces" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/HDrVUjgtXXVEkFXv/icons/xds/icon-microphone.svg?fit=max&auto=format&n=HDrVUjgtXXVEkFXv&q=85&s=2fe9f27995a8a7848a53033cf2f73a71" href="/x-api/spaces/lookup/introduction" width="24" height="24" data-path="icons/xds/icon-microphone.svg">
    Find live audio conversations and participants.
  </Card>

  <Card title="Lists" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/yrNbfyssZy5Znz8E/icons/xds/icon-bulleted-list.svg?fit=max&auto=format&n=yrNbfyssZy5Znz8E&q=85&s=7f9b8378df9c68798147229d34e3c132" href="/x-api/lists/list-lookup/introduction" width="24" height="24" data-path="icons/xds/icon-bulleted-list.svg">
    Create and manage curated lists of accounts.
  </Card>

  <Card title="Likes" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/H2UMPDwEU_AY-O-e/icons/xds/icon-heart.svg?fit=max&auto=format&n=H2UMPDwEU_AY-O-e&q=85&s=e0ea8e4362c7bd65eb3d8193538c7625" href="/x-api/posts/likes/introduction" width="24" height="24" data-path="icons/xds/icon-heart.svg">
    Like and unlike posts. Look up who liked a post.
  </Card>

  <Card title="Trends" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/8F4a3JZSzxaWjcbM/icons/xds/icon-feather-chart-line.svg?fit=max&auto=format&n=8F4a3JZSzxaWjcbM&q=85&s=c59692d19348ea173cead6a81a0df57e" href="/x-api/trends/trends-by-woeid/introduction" width="24" height="24" data-path="icons/xds/icon-feather-chart-line.svg">
    Trending topics by location and personalized trends.
  </Card>

  <Card title="Media" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/ZoQkjcRw6TIbGlxg/icons/xds/icon-photo.svg?fit=max&auto=format&n=ZoQkjcRw6TIbGlxg&q=85&s=c766713d6616979fbd17a4a33b54bd78" href="/x-api/media/introduction" width="24" height="24" data-path="icons/xds/icon-photo.svg">
    Upload images, videos, and GIFs. Manage subtitles and metadata.
  </Card>

  <Card title="Communities" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/HDrVUjgtXXVEkFXv/icons/xds/icon-people.svg?fit=max&auto=format&n=HDrVUjgtXXVEkFXv&q=85&s=164ad227a9590a450514669f6e218cd4" href="/x-api/communities/lookup/introduction" width="24" height="24" data-path="icons/xds/icon-people.svg">
    Look up and search communities.
  </Card>

  <Card title="Community Notes" icon="note-sticky" href="/x-api/community-notes/introduction">
    Create, evaluate, and search community notes.
  </Card>

  <Card title="News" icon="newspaper" href="/x-api/news/introduction">
    Search and retrieve news stories.
  </Card>

  <Card title="Compliance" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/2IJWfWes_KW2nqKP/icons/xds/icon-shield-check.svg?fit=max&auto=format&n=2IJWfWes_KW2nqKP&q=85&s=11bce2d7a9b1296613c1002b93b6a079" href="/x-api/compliance/batch-compliance/introduction" width="24" height="24" data-path="icons/xds/icon-shield-check.svg">
    Batch compliance jobs and compliance streams.
  </Card>
</CardGroup>

***

## Streaming & real-time

<CardGroup cols={3}>
  <Card title="Filtered Stream" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/H2UMPDwEU_AY-O-e/icons/xds/icon-filter.svg?fit=max&auto=format&n=H2UMPDwEU_AY-O-e&q=85&s=a514914bc0032c1f3f6145e57adbe336" href="/x-api/posts/filtered-stream/introduction" width="24" height="24" data-path="icons/xds/icon-filter.svg">
    Get posts delivered in real-time matching your filter rules.
  </Card>

  <Card title="X Activity" icon="bolt" href="/x-api/activity/introduction">
    Subscribe to real-time activity events like follows, likes, and profile updates.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/x-api/webhooks/introduction">
    Receive event data via HTTP callbacks.
  </Card>
</CardGroup>

***

## Enterprise-only

These endpoints require an [Enterprise plan](/enterprise-api/introduction).

<CardGroup cols={3}>
  <Card title="Volume Streams" icon="satellite-dish" href="/x-api/posts/volume-streams/introduction">
    Full firehose and language-specific streams.
  </Card>

  <Card title="Likes Streams" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/H2UMPDwEU_AY-O-e/icons/xds/icon-heart.svg?fit=max&auto=format&n=H2UMPDwEU_AY-O-e&q=85&s=e0ea8e4362c7bd65eb3d8193538c7625" href="/x-api/stream/likes-streams-introduction" width="24" height="24" data-path="icons/xds/icon-heart.svg">
    Stream all or sampled likes in real-time.
  </Card>

  <Card title="Powerstream" icon="bolt" href="/x-api/powerstream/introduction">
    High-performance filtered streaming with advanced operators.
  </Card>

  <Card title="Analytics" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/K_EDPi0sX8nSJWO1/icons/xds/icon-bar-chart.svg?fit=max&auto=format&n=K_EDPi0sX8nSJWO1&q=85&s=737014205db1c127479300c6ff5d6a2f" href="/x-api/posts/get-post-analytics" width="24" height="24" data-path="icons/xds/icon-bar-chart.svg">
    Post and media engagement metrics at scale.
  </Card>

  <Card title="Account Activity" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/K_EDPi0sX8nSJWO1/icons/xds/icon-bell.svg?fit=max&auto=format&n=K_EDPi0sX8nSJWO1&q=85&s=e5770b26a94c91e5370ca489c58a8a49" href="/x-api/account-activity/introduction" width="24" height="24" data-path="icons/xds/icon-bell.svg">
    Real-time user event subscriptions.
  </Card>

  <Card title="Stream Webhooks" icon="webhook" href="/x-api/webhooks/stream/introduction">
    Filtered stream delivery via webhooks.
  </Card>
</CardGroup>

***

## Quick start

```bash theme={null}
curl "https://api.x.com/2/users/by/username/xdevelopers" \
  -H "Authorization: Bearer $BEARER_TOKEN"
```

<CardGroup cols={2}>
  <Card title="Make your first request" icon="https://mintcdn.com/x-preview-mintlify-508d47e7/ZoQkjcRw6TIbGlxg/icons/xds/icon-rocket.svg?fit=max&auto=format&n=ZoQkjcRw6TIbGlxg&q=85&s=daeea53680cb63e65f5afdaa0a61ff99" href="/x-api/getting-started/make-your-first-request" width="24" height="24" data-path="icons/xds/icon-rocket.svg">
    Get your credentials and call the API in minutes.
  </Card>

  <Card title="SDKs" icon="cube" href="/tools-and-libraries">
    Official Python and TypeScript libraries.
  </Card>
</CardGroup>
