@font-face {
    font-family: "GraphikWide";
    src: url("https://mintlify-assets.b-cdn.net/x/GraphikWide-Semibold-Trial.woff") format("woff");
    font-weight: 600;
}

.font-branded, h1, h2, h3  {
  font-family: "GraphikWide";
  letter-spacing: -1%;
}

.form {
  padding: 15px;
  width: 100%;
  min-height: 300px;
  overflow-y: auto;
}

.rate-limit-table th {
  text-align: left;
}

tr td[data-label="Endpoint"] a {
  font-size: 12px;
}

tr td[data-label="Pro Limit"],
tr td[data-label="Basic Limit"],
tr td[data-label="Free Limit"] {
  font-size: 12px;
}

td[data-label="Pro Limit"] strong,
td[data-label="Basic Limit"] strong,
td[data-label="Free Limit"] strong {
  margin-bottom: 8px;
  display: block;
}

.text-hero {
  color: white;
  font-weight: 600;
  font-size: 3rem;
  margin: 0;
}

@media (max-width: 767px) {
  .text-hero {
    font-size: 2rem;
  }
}

Developer Portal

Forums

GitHub

Home

Get started

X API

X Ads API

Tutorials

Use Cases

Changelog

Developer portal

Support

Creates a compliance for the given job type

Create compliance job

URL from which the user will retrieve their compliance results.

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

URL to which the user will upload their Tweet or user IDs.

A request to create a new batch compliance job.

BearerToken

Platform overview

Developer Apps

Projects

Overview

Authentication

Basic authentication

OAuth FAQ

API reference

OAuth API reference index

Counting characters

Counting characters when composing Tweets

Rate limits

X IDs

Security

Partner Directory

X Official Partner

Customer Directory

Enterprise data customers

Enterprise Access Form

Government End User Request Form

Tools and libraries

Instructions and examples to help you get started.

API Reference Index

Introduction

About the X API

Getting access

How to get access to the X API

Make your first request

Make your first request to the X API

Important resources

SDKs

Data Formation Migration

X API endpoint map

What to build

X API v2 data dictionary

Fields

Expansions

Post Annotations

Metrics

Conversation ID

Pagination

Versioning

Consistency

Edit Posts

Step-by-step guide

Increasing access

Ads API hierarchy and terminology

Accessing Ads accounts

Making Authenticated Requests

Error codes and responses

Rate limiting

Sorting

Versions

Timezones

Currency

Sandbox

Analytics

Audiences

Campaign Management

Catalog Management

Creatives

Mobile Conversions

Web conversions

AB Testing

The user Post timeline and user mention timeline endpoints allow developers to retrieve the public Posts composed by, or mentioning a user.

Explore a user’s Posts

Explore a user’s Posts and mentions with the X API v2

In this tutorial, we will discuss what Postman is and how to quickly get set up with it.

Getting started with Postman

Getting historical Posts using the v2 full-archive search endpoint

Use X's powerful APIs to help your business listen, act, and discover.

Build for businesses

Build for people on X, to enhance and improve their experience on the platform.

Build for the public

Use the X API to get historical and real-time data points for your next research project.

Do research

Teach or learn valuable skills with the X API.

Teach and learn

Build for good

Begin using the X API in seconds with one of our access plans.

Build for fun

The X Developer Platform is updated frequently with new functionality and products to better suit your needs. We will be documenting all changes made to the platform’s products via this resource and the @API X account.

Full-archive search

Returns Posts from the last 7 days that match a search query.

Recent search

Returns Post Counts that match a search query.

Full archive search counts

Returns Post Counts from the last 7 days that match a search query.

Recent search counts

Streams Posts matching the stream's active rule set.

Filtered stream

Returns rules from a User's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.

Rules lookup

Returns the counts of rules from a User's active rule set, to reflect usage by project and application.

Rules Count

Add or delete rules from a User's active rule set. Users can provide unique, optionally tagged rules to add. Users can delete their entire rule set or a subset specified by rule ids or values.

Add/Delete rules

The X API v2 has three timelines endpoints - reverse chronological home timeline, user Post timeline, and user mention timeline. See below for more details.

Returns a list of Posts authored by the provided User ID

User Posts timeline by User ID

Returns Post objects that mention username associated to the provided User ID

User mention timeline by User ID

Returns Post objects that appears in the provided User ID's home timeline

User home timeline by User ID

Returns a variety of information about the Post specified by the requested ID.

Post lookup by Post IDs

Post lookup by Post ID

Returns Post objects that have been bookmarked by the requesting User

Bookmarks by User

Adds a Post (ID in the body) to the requesting User's (in the path) bookmarks

Add Post to Bookmarks

Removes a Post from the requesting User's bookmarked Posts.

Remove a bookmarked Post

Causes the User to create a Post under the authorized account.

Creation of a Post

Delete specified Post (in the path) by ID.

Post delete by Post ID

Returns a list of Users that have retweeted the provided Post ID

Returns User objects that have retweeted the provided Post ID

Causes the User (in the path) to repost the specified Post. The User in the path must match the User context authorizing the request.

Causes the User (in the path) to repost the specified Post.

Causes the User (in the path) to unretweet the specified Post. The User must match the User context authorizing the request

Causes the User (in the path) to unretweet the specified Post

Returns a variety of information about each Post that has retweeted the Post specified by the requested ID.

Retrieve Posts that repost a Post.

This endpoint returns reposts of the requesting User.

Returns repost of user

Returns a variety of information about each Post that quotes the Post specified by the requested ID.

Retrieve Posts that quote a Post.

Apps

Hides or unhides a reply to an owned conversation.

Hide replies

Firehose stream

Streams 100% of English Language public Posts.

English Language Firehose stream

Streams 100% of Japanese Language public Posts.

Japanese Language Firehose stream

Streams 100% of Korean Language public Posts.

Korean Language Firehose stream

Streams 100% of Portuguese Language public Posts.

Portuguese Language Firehose stream

Streams a deterministic 1% of public Posts.

Sample stream

Streams a deterministic 10% of public Posts.

Sample 10% stream

This endpoint returns information about a User. Specify User by ID.

User lookup by ID

This endpoint returns information about Users. Specify Users by their ID.

User lookup by IDs

This endpoint returns information about Users. Specify Users by their username.

User lookup by usernames

This endpoint returns information about a User. Specify User by username.

User lookup by username

This endpoint returns information about the requesting User.

User lookup me

User search

Returns a list of Users who are followers of the specified User ID.

Followers by User ID

Returns a list of Users that are being followed by the provided User ID

Following by User ID

Causes the User(in the path) to follow, or “request to follow” for protected Users, the target User. The User(in the path) must match the User context authorizing the request

Follow User

Causes the source User to unfollow the target User. The source User must match the User context authorizing the request

Unfollow User

Causes the User (in the path) to mute the target User. The User (in the path) must match the User context authorizing the request.

Mute User by User ID.

Causes the source User to unmute the target User. The source User must match the User context authorizing the request

Overview

Posts

Users

Engagement Metrics

Direct Messages

Likes

Lists

Spaces

Communities

Trends

Media Upload

Usage

Compliance

Enterprise (Gnip 2.0)

Create compliance job

Authorizations

Body

Response