> ## Documentation Index
> Fetch the complete documentation index at: https://x-preview-mintlify-60eb6c0c.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-60eb6c0c/uusmjcW4dEaMOq_J/icons/xds/icon-chat.svg?fit=max&auto=format&n=uusmjcW4dEaMOq_J&q=85&s=afda6230a0b89ab71775fb10d37cf6f1" 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-60eb6c0c/1R9knCYxKxi-ssBs/icons/xds/icon-person.svg?fit=max&auto=format&n=1R9knCYxKxi-ssBs&q=85&s=fbcec80b15b47f4136cbe213debd66cb" 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-60eb6c0c/1Bnnb-U5SO1k6pVl/icons/xds/icon-envelope.svg?fit=max&auto=format&n=1Bnnb-U5SO1k6pVl&q=85&s=30de2597a3d11073a1cc2bfc20fae551" 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-60eb6c0c/1R9knCYxKxi-ssBs/icons/xds/icon-microphone.svg?fit=max&auto=format&n=1R9knCYxKxi-ssBs&q=85&s=821a106fcfe9c71ba6e86507ef728809" 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-60eb6c0c/uusmjcW4dEaMOq_J/icons/xds/icon-bulleted-list.svg?fit=max&auto=format&n=uusmjcW4dEaMOq_J&q=85&s=c2d1eed486e326e0d20c5f4731ebb83c" 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-60eb6c0c/PA2_STejai64smcg/icons/xds/icon-heart.svg?fit=max&auto=format&n=PA2_STejai64smcg&q=85&s=8d7af396a7f4efc92df096318ad8e70d" 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-60eb6c0c/1Bnnb-U5SO1k6pVl/icons/xds/icon-feather-chart-line.svg?fit=max&auto=format&n=1Bnnb-U5SO1k6pVl&q=85&s=2e9d87911b3c7032756170863f42c74e" 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-60eb6c0c/EVRr2GANOSDdEtkQ/icons/xds/icon-photo.svg?fit=max&auto=format&n=EVRr2GANOSDdEtkQ&q=85&s=6bafa3dbac9ecc1badc8ef20a51ac6b3" 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-60eb6c0c/1R9knCYxKxi-ssBs/icons/xds/icon-people.svg?fit=max&auto=format&n=1R9knCYxKxi-ssBs&q=85&s=3118803f1ae695115980f89ad16c0e89" 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-60eb6c0c/60I_Vfgpy01nr3Wn/icons/xds/icon-shield-check.svg?fit=max&auto=format&n=60I_Vfgpy01nr3Wn&q=85&s=f26436f735c8eb35bcc60954ac07eb86" 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-60eb6c0c/PA2_STejai64smcg/icons/xds/icon-filter.svg?fit=max&auto=format&n=PA2_STejai64smcg&q=85&s=00c7f8b3bafcbf25790eeba806ff0c2f" 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-60eb6c0c/PA2_STejai64smcg/icons/xds/icon-heart.svg?fit=max&auto=format&n=PA2_STejai64smcg&q=85&s=8d7af396a7f4efc92df096318ad8e70d" 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-60eb6c0c/Qcb-Ox6I1FsPiErS/icons/xds/icon-bar-chart.svg?fit=max&auto=format&n=Qcb-Ox6I1FsPiErS&q=85&s=1b3d39bea6a98bd51e161f6c5d87bb1e" 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-60eb6c0c/Qcb-Ox6I1FsPiErS/icons/xds/icon-bell.svg?fit=max&auto=format&n=Qcb-Ox6I1FsPiErS&q=85&s=17db564c72f41f328aee615d1808c5b7" 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-60eb6c0c/EVRr2GANOSDdEtkQ/icons/xds/icon-rocket.svg?fit=max&auto=format&n=EVRr2GANOSDdEtkQ&q=85&s=1be772569e5885afc523679008dfffd2" 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>
