Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Changelog
description: "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 platforms products via this resource and the @API X account."
description: "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."
sidebarTitle: Overview
keywords: ["changelog", "API updates", "release notes", "what's new", "API changes", "version updates", "platform updates"]
---

To subscribe to updates, please [**“Turn on notifications”**](https://help.x.com/en/managing-your-account/notifications-on-mobile-devices#:~:text=In%20the%20top%20menu,%20you,you%20would%20like%20to%20receive) for [**@API**](https://x.com/api).
Expand Down
1 change: 1 addition & 0 deletions developer-terms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Policies and agreements
sidebarTitle: Developer Terms
mode: wide
icon: gavel
keywords: ["developer terms", "developer policy", "terms of service", "developer agreement", "API terms", "policy", "agreement", "restricted use cases"]
---

import { Button } from '/snippets/button.mdx';
Expand Down
1 change: 1 addition & 0 deletions developer-terms/ads-api-agreement.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Ads API Agreement"
keywords: ["Ads API agreement", "advertising API terms", "ads API terms of service", "ads API contract", "advertising agreement", "X Ads API agreement"]
---

We have updated our Ads API Agreement. The changes below are effective as of February 23, 2025.
Expand Down
1 change: 1 addition & 0 deletions developer-terms/agreement.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "X Developer Agreement"
keywords: ["developer agreement", "API agreement", "terms of service", "developer terms", "X developer agreement", "API terms", "developer contract"]
---

Last Updated: October 17, 2025
Expand Down
1 change: 1 addition & 0 deletions developer-terms/geo-guidelines.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Geo guidelines"
keywords: ["geo guidelines", "geotagging", "location data", "geographic data", "location guidelines", "geo features", "posting with location"]
---

Last Update: October 22, 2014.
Expand Down
1 change: 1 addition & 0 deletions developer-terms/policy.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "X Developer Policy"
keywords: ["developer policy", "API policy", "developer guidelines", "policy", "API usage policy", "developer rules", "platform policy"]
---

## X + Developers
Expand Down
1 change: 1 addition & 0 deletions developer-terms/ppu-pilot-agreement.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 'X Developer PPU Pilot Agreement'
keywords: ["PPU pilot", "pay per use", "PPU agreement", "pilot program", "credits", "paid services", "pilot agreement"]
---

By clicking “Pay,” and purchasing credits for use on Paid Services, or by otherwise accessing or using any Licensed Material, you agree to the terms of our Agreement. Credits do not expire unless otherwise specified, and are not transferable or refundable except as required by law. A verified phone number is required to purchase Credits.
Expand Down
1 change: 1 addition & 0 deletions developer-terms/restricted-use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "More about restricted uses of the X APIs"
keywords: ["restricted use cases", "API restrictions", "prohibited uses", "sensitive information", "API limitations", "restricted usage", "forbidden uses"]
---

Use of our developer platform requires that you review and agree to our [Developer Agreement and Policy](/developer-terms/agreement), as well as our related policies, including the [Display Requirements](https://developer.x.com/en/developer-terms/display-requirements.html) and [Automation Rules](https://help.twitter.com/en/rules-and-policies/twitter-automation). Among other things, our agreements and policies provide guidance about several restricted use cases. We’ve provided additional information about some of these restrictions below.
Expand Down
1 change: 1 addition & 0 deletions enterprise/customer-directory.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Enterprise data customers"
sidebarTitle: "Customer Directory"
keywords: ["enterprise customers", "customer directory", "enterprise data", "enterprise API customers", "data customers"]
---

import { LogoCard } from '/snippets/logo_card.mdx';
Expand Down
1 change: 1 addition & 0 deletions enterprise/partner-directory.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: X Official Partner
sidebarTitle: Partner Directory
keywords: ["partners", "official partners", "partner directory", "X partners", "partner program", "enterprise partners"]
---
import { IntroCard } from '/snippets/card.mdx';
import { Button } from '/snippets/button.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/application-trial.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Application for Trial Enterprise Access"
keywords: ["trial access", "enterprise trial", "trial application", "trial form", "free trial", "trial enterprise"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/billing-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Billing support form
sidebarTitle: Billing Support
icon: headset
keywords: ["billing support", "billing help", "payment support", "billing questions", "payment issues", "billing form"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/enterprise-api-interest.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Enterprise Access Form
keywords: ["enterprise access", "enterprise API", "apply for enterprise", "enterprise form", "enterprise access form"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/government-end-user-request.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Government End User Request Form
keywords: ["government", "government access", "government form", "public sector", "government API access", "government request"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/survey.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Survey: Product Tracks & Commercial Use"
keywords: ["survey", "product survey", "commercial use", "developer survey", "feedback survey", "product tracks"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/use-case/initial.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Prospective Customer - Initial Application"
keywords: ["initial application", "prospective customer", "use case application", "apply for access", "initial request", "customer application"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/use-case/modification.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Existing Customer - Use Case Modification"
keywords: ["use case modification", "modify use case", "update use case", "change use case", "use case change", "modify application"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/use-case/public-sector.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Existing Customer - Public Sector Request"
keywords: ["public sector", "government request", "public sector access", "government use case", "public sector form", "government application"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions forms/use-case/upgrade.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Existing Customer - Add New Data Product(s)"
keywords: ["upgrade", "add data products", "upgrade access", "add products", "data product upgrade", "upgrade form"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth API reference index
sidebarTitle: API reference
keywords: ["OAuth API reference", "authentication API", "OAuth endpoints", "auth endpoints", "OAuth reference", "API reference"]
---

### OAuth 1.0a
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/basic-auth.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Basic authentication
sidebarTitle: Basic authentication
keywords: ["basic authentication", "HTTP basic auth", "enterprise authentication", "basic auth", "HTTP authentication", "enterprise API auth"]
---

## Basic authentication
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth FAQ
sidebarTitle: FAQ
keywords: ["OAuth FAQ", "authentication FAQ", "OAuth questions", "authentication help", "OAuth troubleshooting", "auth FAQ"]
---

## General
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Best practices
keywords: ["authentication best practices", "OAuth best practices", "security best practices", "API key security", "token security", "auth security"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/guides/log-in-with-x.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Log in with X
keywords: ["Log in with X", "Sign in with X", "X login", "OAuth login", "social login", "X authentication", "login integration"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/guides/tls.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Connection to X API using TLS
sidebarTitle: TLS
keywords: ["TLS", "SSL", "HTTPS", "secure connection", "TLS connection", "encrypted connection", "API security"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: X API v2 authentication mapping
sidebarTitle: Endpoint mapping
keywords: ["authentication mapping", "v2 authentication", "endpoint mapping", "auth mapping", "v1 to v2 mapping", "authentication guide"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: API Key and Secret
sidebarTitle: API Key and Secret
keywords: ["API key", "API secret", "consumer key", "consumer secret", "OAuth 1.0a keys", "API credentials", "developer keys"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authorizing a request
sidebarTitle: Authorizing a request
keywords: ["authorize request", "OAuth authorization", "request authorization", "OAuth 1.0a authorization", "authorize API request"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Creating a signature
sidebarTitle: Creating a signature
keywords: ["OAuth signature", "create signature", "OAuth 1.0a signature", "HMAC signature", "signature generation", "OAuth signing"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-1-0a/oauth-echo.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth Echo
sidebarTitle: OAuth Echo
keywords: ["OAuth echo", "OAuth echo test", "OAuth verification", "echo test", "OAuth 1.0a echo", "verify OAuth"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Obtaining Access Tokens using 3-legged OAuth flow
sidebarTitle: User Access Tokens (3-legged OAuth flow)
keywords: ["3-legged OAuth", "user access tokens", "OAuth flow", "obtain access tokens", "OAuth 1.0a flow", "access token generation"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-1-0a/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth 1.0a
sidebarTitle: Overview
keywords: ["OAuth 1.0a", "OAuth 1.0", "OAuth 1.0a authentication", "OAuth 1.0a user context", "three-legged OAuth", "OAuth 1.0a flow"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Percent encoding parameters
sidebarTitle: Percent encoding parameters
keywords: ["percent encoding", "URL encoding", "OAuth encoding", "parameter encoding", "URL encode", "OAuth 1.0a encoding"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-1-0a/pin-based-oauth.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: PIN-based authorization
sidebarTitle: PIN-based OAuth
keywords: ["PIN-based OAuth", "PIN OAuth", "OAuth PIN", "PIN authorization", "OAuth 1.0a PIN", "desktop OAuth"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-2-0/application-only.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: App only authentication and OAuth 2.0 Bearer Token
sidebarTitle: OAuth 2.0 App-Only (Bearer Token)
keywords: ["app-only authentication", "OAuth 2.0 app-only", "Bearer Token authentication", "app-only auth", "read-only access", "public data access"]
---

### App only authentication and OAuth 2.0 Bearer Token
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth 2.0 Authorization Code Flow with PKCE
sidebarTitle: OAuth 2.0 Authorization Code Flow with PKCE
keywords: ["OAuth 2.0 PKCE", "authorization code flow", "PKCE", "OAuth 2.0 flow", "PKCE flow", "OAuth 2.0 authorization", "code challenge"]
---

### OAuth 2.0 Authorization Code Flow with PKCE
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-2-0/bearer-tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Using and generating an app-only Bearer Token
sidebarTitle: Generating and using app-only Bearer Tokens
keywords: ["Bearer token", "app-only token", "Bearer Token", "OAuth 2.0 Bearer", "app authentication", "generate Bearer token"]
---

### Using and generating an app-only Bearer Token
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/oauth-2-0/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: OAuth 2.0
sidebarTitle: Overview
keywords: ["OAuth 2.0", "OAuth 2.0 authentication", "OAuth 2.0 PKCE", "Bearer token", "app-only auth", "OAuth 2.0 flow", "authorization code"]
---

### Bearer Token (also known as app-only)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: How to connect to endpoints using OAuth 2.0 Authorization Code Flow with PKCE
sidebarTitle: OAuth 2.0 Making requests on behalf of users
keywords: ["OAuth 2.0 user access token", "user access token", "OAuth 2.0 user context", "user authentication", "OAuth 2.0 user", "access token"]
---

### How to connect to endpoints using OAuth 2.0 Authorization Code Flow with PKCE
Expand Down
1 change: 1 addition & 0 deletions fundamentals/authentication/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authentication
sidebarTitle: Overview
keywords: ["authentication", "OAuth", "OAuth 1.0a", "OAuth 2.0", "API authentication", "bearer token", "access tokens", "API keys", "user context", "app only", "PKCE", "authorization code", "basic authentication"]
---

import { Button } from "/snippets/button.mdx";
Expand Down
1 change: 1 addition & 0 deletions fundamentals/counting-characters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Counting characters when composing Tweets
sidebarTitle: Counting characters
icon: text-size
keywords: ["character counting", "tweet length", "280 characters", "character limits", "Unicode", "emoji characters", "CJK characters", "URL length", "tweet composition", "twitter-text", "character encoding", "UTF-8"]
---

This page describes how characters are treated when composing Tweets and across the X API. For more information on the implementation, X provides an Open Source [twitter-text](http://github.com/twitter/twitter-text) library that can be found on [GitHub](https://github.com/twitter).
Expand Down
1 change: 1 addition & 0 deletions fundamentals/developer-apps.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Apps
icon: wrench
keywords: ["X apps", "developer apps", "API keys", "OAuth", "authentication", "app management", "developer portal", "API credentials", "access tokens", "OAuth 1.0a", "OAuth 2.0", "API key and secret", "client ID", "client secret", "app permissions", "callback URLs"]
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions fundamentals/developer-portal.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Developer Portal"
icon: "globe"
keywords: ["developer portal", "X developer portal", "API dashboard", "developer account", "project management", "app management", "team management", "developer onboarding", "API access", "developer tools"]
---

import { Button } from '/snippets/button.mdx';
Expand Down
1 change: 1 addition & 0 deletions fundamentals/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Projects
icon: folder-open
keywords: ["X projects", "API projects", "developer projects", "API access levels", "free tier", "basic tier", "pro tier", "enterprise tier", "tweet caps", "API subscription", "project management", "standalone apps"]
---

## Introduction
Expand Down
1 change: 1 addition & 0 deletions fundamentals/rate-limits.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Rate limits
icon: gauge-simple-high
keywords: ["rate limits", "API rate limits", "request limits", "API throttling", "rate limiting", "X API rate limits", "Ads API rate limits", "enterprise API rate limits"]
---

Everyday many thousands of developers make requests to the X developer platform. To help manage the sheer volume of these requests, limits are placed on the number of requests that can be made. These limits help us provide the reliable and scalable API that our developer community relies on.
Expand Down
1 change: 1 addition & 0 deletions fundamentals/security.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Security
icon: lock
keywords: ["security", "API security", "developer security", "secure coding", "OAuth security", "API keys security", "token security", "XSS", "CSRF", "SQL injection", "encryption", "TLS", "vulnerability reporting", "security best practices"]
---

We believe privacy is a right, not a privilege, and it is built into the foundations of our company. By using the X developer platform and abiding by our developer policy, you play a critical role in making sure the platform serves the public conversation on X and safeguards our commitment to privacy.
Expand Down
1 change: 1 addition & 0 deletions fundamentals/x-ids.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: X IDs
icon: id-card-clip
keywords: ["X IDs", "Twitter IDs", "user ID", "tweet ID", "snowflake ID", "64-bit integers", "ID format", "ID string", "unique identifiers"]
---

Each object within X - a Tweet, Direct Message, User, List, and so on - has a unique ID.
Expand Down
1 change: 1 addition & 0 deletions incidents.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Incident History
keywords: ["incidents", "incident history", "outages", "service issues", "API incidents", "system status", "downtime"]
---

## October 2025
Expand Down
1 change: 1 addition & 0 deletions livestreams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: X Developer Platform Livestreams
sidebarTitle: Livestreams
mode: wide
icon: video
keywords: ["livestreams", "video tutorials", "developer videos", "webinars", "broadcasts", "recordings", "developer education"]
---

import { BroadcastCarousel } from '/snippets/broadcast-carousel.mdx';
Expand Down
1 change: 1 addition & 0 deletions newsletter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Subscribe to developer news
sidebarTitle: Newsletter
mode: wide
icon: envelope
keywords: ["newsletter", "developer newsletter", "subscribe", "updates", "developer news", "product updates", "developer events"]
---

import { Form } from '/snippets/form.mdx';
Expand Down
1 change: 1 addition & 0 deletions overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Welcome to the X Developer Platform
sidebarTitle: Overview
mode: wide
icon: hand-wave
keywords: ["X API", "Twitter API", "developer platform", "API documentation", "X developer", "API keys", "SDK", "Python SDK", "TypeScript SDK", "API integration", "developer tools", "API quickstart", "X Ads API", "X for Websites"]
---

import { Button } from '/snippets/button.mdx';
Expand Down
Loading