Tools & Libraries

Official SDKs, community libraries, and developer tools for the X API

Speed up your development with official SDKs, community libraries, and developer tools.

---

Official SDKs

X provides official SDKs for TypeScript and Python with full X API v2 support.

Python SDK

Async support, type hints, and automatic token refresh. Perfect for data analysis and automation.

TypeScript SDK

Full type safety and ESM support. Works in Node.js and modern bundlers.

Why use the official SDKs?

Benefit	Description
Always up-to-date	Maintained by X, updated with new endpoints
Type safety	Full type definitions for all objects and methods
Built-in auth	OAuth 2.0 and OAuth 1.0a support
Automatic pagination	Iterate through results without manual token handling

Quick start

Python

Installation

pip install xdk

Basic usage

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Search for posts (returns an iterator)
for page in client.posts.search_recent(query="api", max_results=10):
    if page.data and len(page.data) > 0:
        first_post = page.data[0]
        print(first_post.text)
        break

TypeScript

Installation

npm install @xdevplatform/xdk

Basic usage

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

// Look up a user
const userResponse = await client.users.getByUsername('XDevelopers');
console.log(userResponse.data?.username);

Authentication

Both SDKs support multiple authentication methods:

Bearer Token (App-only)

Simplest option for reading public data.

Python:

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

TypeScript:

import { Client } from '@xdevplatform/xdk';

const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });

OAuth 2.0 (User Context)

For actions on behalf of users (posting, following, etc.).

Python:

from xdk import Client
from xdk.oauth2_auth import OAuth2PKCEAuth

auth = OAuth2PKCEAuth(
    client_id="YOUR_CLIENT_ID",
    redirect_uri="YOUR_CALLBACK_URL",
    scope="tweet.read users.read offline.access"
)

# Get authorization URL
auth_url = auth.get_authorization_url()

# After user authorizes, exchange code for tokens
tokens = auth.fetch_token(authorization_response=callback_url)
client = Client(bearer_token=tokens["access_token"])

TypeScript:

import { Client, OAuth2, generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';

const oauth2 = new OAuth2({
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
  redirectUri: 'https://your-app.com/callback',
  scope: ['tweet.read', 'users.read', 'offline.access'],
});

const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl = await oauth2.getAuthorizationUrl('state');

// After authorization, exchange code
const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });

OAuth 1.0a (User Context)

For legacy applications or specific use cases.

Python:

from xdk import Client
from xdk.oauth1_auth import OAuth1

oauth1 = OAuth1(
    api_key="YOUR_API_KEY",
    api_secret="YOUR_API_SECRET",
    access_token="YOUR_ACCESS_TOKEN",
    access_token_secret="YOUR_ACCESS_TOKEN_SECRET"
)

client = Client(auth=oauth1)

TypeScript:

import { Client, OAuth1 } from '@xdevplatform/xdk';

const oauth1 = new OAuth1({
  apiKey: 'YOUR_API_KEY',
  apiSecret: 'YOUR_API_SECRET',
  accessToken: 'YOUR_ACCESS_TOKEN',
  accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET'
});

const client = new Client({ oauth1: oauth1 });

Available methods

The SDKs provide methods for all X API v2 endpoints:

Category	Python	TypeScript
Posts	client.posts.search_recent()	client.posts.search()
Users	client.users.get_me()	client.users.getMe()
Spaces	client.spaces.get()	client.spaces.findSpaceById()
Lists	client.lists.get()	client.lists.getList()
DMs	client.direct_messages.get()	client.directMessages.lookup()

Python SDK Docs

Complete Python documentation.

TypeScript SDK Docs

Complete TypeScript documentation.

Python GitHub

Source code and issues.

TypeScript GitHub

Source code and issues.

---

Official tools

Tool	Description
Postman Collection	Interactive API testing for all v2 endpoints
xurl	Command line tool for the X APIs that handles authentication for you
OpenAPI Spec	Machine-readable API specification
twitter-text	Parse and validate post text, count characters
Embed Generator	Build embeddable posts, timelines, or buttons for your site

---

Community libraries

These community-maintained libraries support X API v2. Check each library’s documentation for current API coverage.

Python

Library	Description
tweepy	Popular Python library with v2 support
twarc	CLI and library for data collection
python-twitter	Simple Python wrapper
TwitterAPI	Minimal Python wrapper

JavaScript/TypeScript

Library	Description
node-twitter-api-v2	Strongly-typed, full-featured Node.js client
twitter.js	Object-oriented Node.js library
twitter-v2	Async client library

Go

Library	Description
go-twitter	Go library for v2 API
gotwi	Go wrapper for v2
twitter-stream	Filtered stream wrapper

Java/Kotlin

Library	Description
twittered	Java client for v2
twitter4j-v2	Twitter4J v2 wrapper
KTweet	Kotlin v2 library
Tweedle	Kotlin Android library

PHP

Library	Description
twitter-api-v2-php	PHP v2 client
bird-elephant	PHP v2 library
twitteroauth	Popular OAuth library

Ruby

Library	Description
tweetkit	Ruby v2 client
twitter_oauth2	OAuth 2.0 library
omniauth-twitter2	OmniAuth strategy

Other

Language	Library
C#/.NET	Tweetinvi, LinqToTwitter
Rust	twitter-v2
Swift	Twift, TwitterAPIKit
R	academictwitteR
PowerShell	BluebirdPS

Community libraries are not maintained by X. Check their repositories for support and current status.

---

X Ads API libraries

For tools and libraries specific to the X Ads API, see the Ads API tools and libraries page.

---

Code samples

Find examples on GitHub:

• X API v2 Sample Code - Examples in Python, JavaScript, Ruby, and more
• X Developer GitHub - Official repos and tools
• Code Samples Repo - Examples using the official XDKs
• Glitch Examples - Interactive, remixable apps
• Replit Examples - Browser-based coding

---

Building a library?

If you have built an X API library, share it with the community:

1. Post in the Libraries and SDKs forum
2. We may add it to this page!

---

Getting help

Developer Forum

Get help from the community.