> ## Documentation Index
> Fetch the complete documentation index at: https://x-preview-mintlify-b4f5bfb1.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-b4f5bfb1/NEh9mjpH7RaTDEed/icons/xds/icon-chat.svg?fit=max&auto=format&n=NEh9mjpH7RaTDEed&q=85&s=d41b5ee3c6e63a9a39acd28c6568d6dc" 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-b4f5bfb1/VFX2XSyPqtT4SVsH/icons/xds/icon-person.svg?fit=max&auto=format&n=VFX2XSyPqtT4SVsH&q=85&s=d0d289815cdfc8e3c20af259d2f04c46" 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-b4f5bfb1/Xkd8wjAYBUaNeVZi/icons/xds/icon-envelope.svg?fit=max&auto=format&n=Xkd8wjAYBUaNeVZi&q=85&s=a4e3fdf04c6687542b88aa6c8528830e" 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-b4f5bfb1/VFX2XSyPqtT4SVsH/icons/xds/icon-microphone.svg?fit=max&auto=format&n=VFX2XSyPqtT4SVsH&q=85&s=04d1ab715019f2cf6013b1a2ad97dccf" 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-b4f5bfb1/NEh9mjpH7RaTDEed/icons/xds/icon-bulleted-list.svg?fit=max&auto=format&n=NEh9mjpH7RaTDEed&q=85&s=8751ac17be48cbce7d9750daf2641945" 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-b4f5bfb1/JQeJOWY1pPelLM8w/icons/xds/icon-heart.svg?fit=max&auto=format&n=JQeJOWY1pPelLM8w&q=85&s=03fc75aa3f93fad4376a3d92b622adb0" 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-b4f5bfb1/Xkd8wjAYBUaNeVZi/icons/xds/icon-feather-chart-line.svg?fit=max&auto=format&n=Xkd8wjAYBUaNeVZi&q=85&s=eb2233d5c6aa1d3b04d3fefea66c9db4" 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-b4f5bfb1/CJEW78ZoFC_WB4AV/icons/xds/icon-photo.svg?fit=max&auto=format&n=CJEW78ZoFC_WB4AV&q=85&s=f8646f7bce535c4b885d482b9c5cee5a" 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-b4f5bfb1/VFX2XSyPqtT4SVsH/icons/xds/icon-people.svg?fit=max&auto=format&n=VFX2XSyPqtT4SVsH&q=85&s=a87838641b92da2bd42d8ec4805b86c7" 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-b4f5bfb1/Y4pnhTTwR7PxYSWw/icons/xds/icon-shield-check.svg?fit=max&auto=format&n=Y4pnhTTwR7PxYSWw&q=85&s=022179aed55c5074e01a9792517064f7" 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-b4f5bfb1/JQeJOWY1pPelLM8w/icons/xds/icon-filter.svg?fit=max&auto=format&n=JQeJOWY1pPelLM8w&q=85&s=6fcb74f47766174bbd2fd52b6934b028" 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-b4f5bfb1/JQeJOWY1pPelLM8w/icons/xds/icon-heart.svg?fit=max&auto=format&n=JQeJOWY1pPelLM8w&q=85&s=03fc75aa3f93fad4376a3d92b622adb0" 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-b4f5bfb1/E43Ep5Gv29gM6HJ6/icons/xds/icon-bar-chart.svg?fit=max&auto=format&n=E43Ep5Gv29gM6HJ6&q=85&s=d8e59c39f35d2ed23f4351f6d1ee9d21" 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-b4f5bfb1/E43Ep5Gv29gM6HJ6/icons/xds/icon-bell.svg?fit=max&auto=format&n=E43Ep5Gv29gM6HJ6&q=85&s=4031b5fbfdccc677fa362a2b0b2a2b56" 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-b4f5bfb1/CJEW78ZoFC_WB4AV/icons/xds/icon-rocket.svg?fit=max&auto=format&n=CJEW78ZoFC_WB4AV&q=85&s=c4d643f2a562a30abeccca3349337f50" 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>
