TypeScript XDK

Official TypeScript/JavaScript SDK for the X API v2 with full type safety, automatic pagination, event-driven streaming, and support for all authentication methods.

A comprehensive TypeScript SDK for the X API (formerly Twitter API) with advanced features including smart pagination, multiple authentication methods, real-time streaming, and full type safety.

Key Features

• 🔐 Authentication: User Context (OAuth1.0a, OAuth2.0), and App-Only (Bearer token) authentication
• 🔄 Pagination: Automatic pagination with async iteration support
• 📡 Streaming: Event-driven streaming with automatic reconnection
• 📚 Type Safety: Complete TypeScript definitions for all endpoints and parameters
• 🎯 Full X API Support: Users, Posts, Lists, Bookmarks, Communities, and more

Quick Start

quickstart.ts

TypeScript

import { 
    Client, 
    type ClientConfig,
    type Users
} from '@xdevplatform/xdk';

const config: ClientConfig = { bearerToken: 'your-bearer-token' };

const client: Client = new Client(config);

async function main(): Promise<void> {
  const userResponse: Users.GetByUsernameResponse = await client.users.getByUsername('XDevelopers');
  const username: string = userResponse.data?.username!;
  console.log(username);
}

main();

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

const client = new Client({ bearerToken: 'your-bearer-token' });

const userResponse = await client.users.getByUsername('XDevelopers');
const username = userResponse.data.username;
console.log(username);

For detailed code examples using the Javascript/TypeScript XDK, check out our code samples GitHub repo.

What’s Next?

• Installation Guide - Set up the SDK in your project
• Authentication - Learn about different auth methods
• Pagination - Learn about data pagination
• Streaming - Learn about real-time data streaming
• API Reference - Read the complete API documentation