Twitter API TypeScript SDK

https://github.com/xdevplatform/twitter-api-typescript-sdk
Admin
Twitter API TypeScript SDK is a TypeScript and JavaScript library that provides full type safety,...
Tokens:35,857
Snippets:423
Trust Score:9.5
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install dependencies

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/examples/README.md

Install the required packages for the examples.

```bash
npm install
```

--------------------------------

### Install the SDK

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Install the package via npm.

```bash
npm install twitter-api-sdk
```

--------------------------------

### Request Usage Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/request-layer.md

Example of performing a GET request using the request function.

```typescript
import { request } from "twitter-api-sdk";

const response = await request({
  auth: authClient,
  endpoint: "/2/tweets",
  params: { ids: "20" },
  method: "GET",
  max_retries: 2,
});

const data = await response.json();
```

--------------------------------

### Run an example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/examples/README.md

Execute a specific example file using ts-node.

```bash
npx ts-node oauth2-bearer.ts
```

--------------------------------

### Complete API Usage Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/oauth2bearer.md

A full example showing client initialization, user lookup, tweet retrieval, and streaming.

```typescript
import { Client } from "twitter-api-sdk";

async function main() {
  // Create client with bearer token
  const client = new Client(process.env.BEARER_TOKEN);
  
  // Make API requests
  try {
    // Get user by username
    const user = await client.users.findUserByUsername("TwitterDev");
    console.log("User:", user.data);
    
    // Get user's tweets
    const tweets = await client.users.usersIdTweets(user.data.id);
    console.log("Recent tweets:", tweets.data);
    
    // Stream sample tweets
    const stream = client.tweets.sampleStream({
      "tweet.fields": ["author_id", "created_at"],
    });
    
    for await (const tweet of stream) {
      console.log("Tweet:", tweet.data?.text);
    }
  } catch (error) {
    console.error("API Error:", error);
  }
}

main();
```

--------------------------------

### GET /2/users/by

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get users by usernames.

```APIDOC
## GET /2/users/by

### Description
Get users by usernames.

### Method
GET

### Endpoint
/2/users/by

### Parameters
#### Query Parameters
- **Usernames** (array) - Required
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - User objects
```

--------------------------------

### Paginate Usage Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/request-layer.md

Example demonstrating how to iterate through paginated results or access the first page directly.

```typescript
import { paginate } from "twitter-api-sdk";

const followers = paginate({
  auth: authClient,
  endpoint: "/2/users/20/followers",
  method: "GET",
});

// Iterate through all pages
for await (const page of followers) {
  console.log(page.data);
}

// Or get first page
const firstPage = await followers;
console.log(firstPage.data);
```

--------------------------------

### Configure Client instance

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Example showing how to initialize the Client with custom retry logic, timeouts, and headers.

```typescript
import { Client } from "twitter-api-sdk";

const client = new Client(process.env.BEARER_TOKEN, {
  // Rate limit handling
  max_retries: 3,
  
  // Custom timeout (in milliseconds)
  timeout: 30000,
  
  // Custom headers
  headers: {
    "X-Custom-Header": "value",
    "User-Agent": "my-app/1.0.0",
  },
  
  // Custom base URL (for testing or proxying)
  base_url: "https://api.twitter.com",
});
```

--------------------------------

### GET /2/users/by/username/{username}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get single user by username.

```APIDOC
## GET /2/users/by/username/{username}

### Description
Get single user by username.

### Method
GET

### Endpoint
/2/users/by/username/{username}

### Parameters
#### Path Parameters
- **username** (string) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **data** (object) - Single user object
```

--------------------------------

### Rest Usage Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/request-layer.md

Example of using the rest function to fetch and parse JSON data.

```typescript
import { rest } from "twitter-api-sdk";

const tweets = await rest({
  auth: authClient,
  endpoint: "/2/tweets",
  params: { ids: "20" },
  method: "GET",
});

console.log(tweets);
```

--------------------------------

### GET /2/users/me

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get authenticated user info.

```APIDOC
## GET /2/users/me

### Description
Get authenticated user info.

### Method
GET

### Endpoint
/2/users/me

### Parameters
#### Query Parameters
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (object) - Authenticated user object
```

--------------------------------

### GET /2/users

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get users by IDs.

```APIDOC
## GET /2/users

### Description
Get users by IDs.

### Method
GET

### Endpoint
/2/users

### Parameters
#### Query Parameters
- **IDs** (array) - Required
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - User objects
```

--------------------------------

### Building Complex Query Strings

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/utilities.md

Examples of constructing query strings for search, user lookup, and pagination scenarios.

```typescript
import { buildQueryString } from "twitter-api-sdk";

// Tweet search with multiple parameters
const searchParams = buildQueryString({
  query: "from:TwitterDev",
  max_results: 100,
  "tweet.fields": ["author_id", "created_at", "public_metrics"],
  "user.fields": ["verified"],
  expansions: ["author_id"],
  start_time: "2024-01-01T00:00:00Z",
  end_time: "2024-01-31T23:59:59Z",
});
// Result: "query=from%3ATwitterDev&max_results=100&..."

// User lookup with expansions
const userParams = buildQueryString({
  ids: ["20", "21", "22"],
  "user.fields": ["created_at", "public_metrics"],
  expansions: ["pinned_tweet_id"],
});

// Pagination
const paginationParams = buildQueryString({
  id: "20",
  max_results: 100,
  pagination_token: "b26v89c19zqg8o3fpZCYvFLhx",
});
```

--------------------------------

### GET /2/users/{id}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get single user by ID.

```APIDOC
## GET /2/users/{id}

### Description
Get single user by ID.

### Method
GET

### Endpoint
/2/users/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (object) - Single user object
```

--------------------------------

### Configure OAuth2User authentication

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Examples for initializing OAuth2 authentication for confidential server-side clients, public PKCE clients, and clients with custom request options.

```typescript
import { auth, Client } from "twitter-api-sdk";

// For confidential (server-side) clients
const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);

// For public clients with PKCE
const publicAuthClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  // No client_secret for public clients
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
});

const publicClient = new Client(publicAuthClient);

// With custom request options
const authClientCustom = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
  request_options: {
    timeout: 10000,
    headers: { "X-App-Name": "my-app" },
  },
});
```

--------------------------------

### GET /2/users/{id}/following

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get users that user follows.

```APIDOC
## GET /2/users/{id}/following

### Description
Get users that user follows.

### Method
GET

### Endpoint
/2/users/{id}/following

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **max_results** (number) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated following list
```

--------------------------------

### Complete Express.js Authentication Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/authentication.md

A full implementation of the OAuth2 flow using Express, covering login, callback handling, protected API calls, and logout.

```typescript
import express from "express";
import { Client, auth } from "twitter-api-sdk";
import dotenv from "dotenv";

dotenv.config();

const app = express();
const STATE = "random-state-string";

// 1. Initialize auth client
const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);

// 2. Login route - generate and redirect to auth URL
app.get("/login", (req, res) => {
  const authUrl = authClient.generateAuthURL({
    state: STATE,
    code_challenge_method: "s256",
  });
  res.redirect(authUrl);
});

// 3. Callback route - exchange code for token
app.get("/callback", async (req, res) => {
  try {
    const { code, state } = req.query;
    
    // Verify state for CSRF protection
    if (state !== STATE) {
      return res.status(400).send("State mismatch");
    }
    
    // Exchange code for token
    await authClient.requestAccessToken(code);
    
    res.redirect("/dashboard");
  } catch (error) {
    console.error("Auth error:", error);
    res.status(500).send("Authentication failed");
  }
});

// 4. Protected route - make API calls with auto-refresh
app.get("/dashboard", async (req, res) => {
  try {
    // Token is automatically refreshed if expired
    const me = await client.users.findMyUser();
    const tweets = await client.users.usersIdTweets(me.data.id);
    
    res.json({ user: me, tweets });
  } catch (error) {
    console.error("API error:", error);
    res.status(500).send("Failed to fetch user data");
  }
});

// 5. Logout route - revoke token
app.get("/logout", async (req, res) => {
  try {
    await authClient.revokeAccessToken();
    res.redirect("/");
  } catch (error) {
    console.error("Logout error:", error);
    res.status(500).send("Logout failed");
  }
});

app.listen(3000, () => {
  console.log("Go to http://localhost:3000/login");
});
```

--------------------------------

### Check Node.js version

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Verify the installed Node.js version to ensure it meets the minimum requirement of 14.0.0.

```bash
node --version  # Must be >= 14.0.0
```

--------------------------------

### Stream Usage Example

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/request-layer.md

Example of consuming a stream of tweets using an async iterator.

```typescript
import { stream } from "twitter-api-sdk";

const tweets = stream({
  auth: authClient,
  endpoint: "/2/tweets/sample/stream",
  method: "GET",
});

for await (const tweet of tweets) {
  console.log(tweet.data?.text);
}
```

--------------------------------

### Common Type Patterns

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/types.md

Examples of using type-safe OAuth2 scopes, request parameters, request bodies, and authorization headers.

```typescript
import { Client, auth, types } from "twitter-api-sdk";

// Type-safe OAuth2 scopes
const scopes: types.OAuth2Scopes[] = ["tweet.read", "users.read"];

// Type-safe request parameters (autocomplete in IDE)
const followersParams: types.TwitterParams<operations["usersIdFollowers"]> = {
  id: "20",
  max_results: 100,
  pagination_token: undefined,
};

// Type-safe request bodies
const tweetBody: types.TwitterBody<operations["createTweet"]> = {
  text: "Hello, world!",
};

// Authorization headers
const authHeader: types.AuthHeader = {
  Authorization: "Bearer YOUR_TOKEN",
};
```

--------------------------------

### GET /2/spaces/by/creator_ids

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves a paginated list of spaces created by specific users.

```APIDOC
## GET /2/spaces/by/creator_ids

### Description
Get spaces created by users.

### Method
GET

### Endpoint
/2/spaces/by/creator_ids

### Parameters
#### Query Parameters
- **creator_ids** (string) - Required
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated spaces
```

--------------------------------

### GET /2/users/compliance/stream

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Stream user compliance data.

```APIDOC
## GET /2/users/compliance/stream

### Description
Stream user compliance data.

### Method
GET

### Endpoint
/2/users/compliance/stream

### Response
#### Success Response (200)
- **data** (stream) - AsyncGenerator of compliance events
```

--------------------------------

### Get Followers

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/QUICK_REFERENCE.md

Retrieve a user's followers, either by iterating through all pages or fetching the first page.

```typescript
// Iterate through all follower pages
for await (const page of client.users.usersIdFollowers("user-id")) {
  console.log(page.data);  // Array of users
}

// Get first page only
const firstPage = await client.users.usersIdFollowers("user-id");
console.log(firstPage.data);
```

--------------------------------

### GET /2/tweets

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get tweets by IDs.

```APIDOC
## GET /2/tweets

### Description
Get tweets by IDs.

### Method
GET

### Endpoint
/2/tweets

### Parameters
#### Query Parameters
- **ids** (string) - Required
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Tweet objects
```

--------------------------------

### Build and Test

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Commands for building and testing the SDK.

```bash
yarn build
```

```bash
yarn test
```

--------------------------------

### Initialize the Client

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Set up the client using a bearer token.

```typescript
import { Client } from "twitter-api-sdk";

const client = new Client("MY-BEARER-TOKEN");
```

--------------------------------

### Configure PKCE Methods

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/authentication.md

Demonstrates how to generate authorization URLs using either S256 (recommended) or plain code challenge methods.

```typescript
// S256 PKCE (Recommended)
const authUrl = authClient.generateAuthURL({
  state: "random-state",
  code_challenge_method: "s256",
});
// SDK auto-generates code_verifier and code_challenge

// Plain code challenge
const authUrl = authClient.generateAuthURL({
  state: "random-state",
  code_challenge: "my-code-challenge",
  code_challenge_method: "plain",
});
```

--------------------------------

### Configure environment variables

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/examples/README.md

Populate the .env file with necessary credentials for authentication.

```text
BEARER_TOKEN=my-bearer-token
CLIENT_ID=my-client-id
CLIENT_SECRET=my-client-secret
```

--------------------------------

### Initialize Client Class

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/client.md

Demonstrates instantiation of the Client class using a bearer token, an OAuth2User instance, or custom request options.

```typescript
import { Client, auth } from "twitter-api-sdk";

// With bearer token
const client = new Client(process.env.BEARER_TOKEN);

// With OAuth2
const authClient = new auth.OAuth2User({
  client_id: "your-client-id",
  client_secret: "your-client-secret",
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
});
const client = new Client(authClient);

// With custom request options
const client = new Client(token, {
  headers: { "X-Custom-Header": "value" },
});
```

--------------------------------

### GET /2/tweets/{id}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get single tweet by ID.

```APIDOC
## GET /2/tweets/{id}

### Description
Get single tweet by ID.

### Method
GET

### Endpoint
/2/tweets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required

### Response
#### Success Response (200)
- **data** (object) - Single tweet object
```

--------------------------------

### GET /2/users/{id}/retweets

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get user's retweets.

```APIDOC
## GET /2/users/{id}/retweets

### Description
Get user's retweets.

### Method
GET

### Endpoint
/2/users/{id}/retweets

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated retweets
```

--------------------------------

### Project File Structure

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/INDEX.md

A visual representation of the documentation directory layout.

```text
output/
├── README.md                          # Project overview
├── INDEX.md                           # This file
├── QUICK_REFERENCE.md                 # Common operations cheat sheet
├── configuration.md                   # Constructor and request options
├── types.md                           # Type definitions
├── endpoints.md                       # Endpoint catalog
├── errors.md                          # Error handling
└── api-reference/
    ├── client.md                      # Main Client class
    ├── oauth2user.md                  # OAuth2User authentication
    ├── oauth2bearer.md                # OAuth2Bearer authentication
    ├── authentication.md              # Auth guide and flows
    ├── request-layer.md               # Request functions
    └── utilities.md                   # Utility functions
```

--------------------------------

### Configure OAuth2User Clients

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/oauth2user.md

Demonstrates the initialization of confidential clients with a secret and public clients using PKCE.

```typescript
// Confidential client (server)
const authClient = new auth.OAuth2User({
  client_id: CLIENT_ID,
  client_secret: CLIENT_SECRET,  // Keep secret!
  callback: "http://server.example.com/callback",
  scopes: ["tweet.read", "users.read"],
});

// Public client (PKCE with plain method)
const authClient = new auth.OAuth2User({
  client_id: CLIENT_ID,
  // No client_secret
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
});
```

--------------------------------

### GET /2/users/{id}/liked_tweets

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get tweets liked by user.

```APIDOC
## GET /2/users/{id}/liked_tweets

### Description
Get tweets liked by user.

### Method
GET

### Endpoint
/2/users/{id}/liked_tweets

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated liked tweets
```

--------------------------------

### Initialize Client with dotenv

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Load environment variables and initialize the Client and OAuth2User instances.

```typescript
import dotenv from "dotenv";

dotenv.config();

const client = new Client(process.env.BEARER_TOKEN);

const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: process.env.CALLBACK_URL,
  scopes: ["tweet.read", "users.read", "offline.access"],
});
```

--------------------------------

### GET /2/users/{id}/followers

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get user's followers.

```APIDOC
## GET /2/users/{id}/followers

### Description
Get user's followers.

### Method
GET

### Endpoint
/2/users/{id}/followers

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **max_results** (number) - Optional
- **pagination_token** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated followers
```

--------------------------------

### GET /2/users/{id}/mentions

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get tweets mentioning user.

```APIDOC
## GET /2/users/{id}/mentions

### Description
Get tweets mentioning user.

### Method
GET

### Endpoint
/2/users/{id}/mentions

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated tweets
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Define essential authentication and configuration variables in a .env file.

```bash
# Bearer Token (for OAuth2Bearer or app-only authentication)
BEARER_TOKEN=YOUR_BEARER_TOKEN_HERE

# OAuth2 Configuration
CLIENT_ID=YOUR_CLIENT_ID
CLIENT_SECRET=YOUR_CLIENT_SECRET
CALLBACK_URL=http://localhost:3000/callback

# Optional
NODE_ENV=production
API_TIMEOUT=30000
MAX_RETRIES=3
```

--------------------------------

### GET /2/users/{id}/tweets

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get user's tweets.

```APIDOC
## GET /2/users/{id}/tweets

### Description
Get user's tweets.

### Method
GET

### Endpoint
/2/users/{id}/tweets

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **max_results** (number) - Optional
- **pagination_token** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated user tweets
```

--------------------------------

### GET /2/tweets/{id}/liking_users

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get users who liked a tweet.

```APIDOC
## GET /2/tweets/{id}/liking_users

### Description
Get users who liked a tweet.

### Method
GET

### Endpoint
/2/tweets/{id}/liking_users

### Parameters
#### Path Parameters
- **id** (string) - Required
#### Query Parameters
- **max_results** (number) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated user list
```

--------------------------------

### Importing Types

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/types.md

Demonstrates how to import individual types, the types namespace, and apply them to API parameters.

```typescript
// Import individual types
import { types, Client } from "twitter-api-sdk";
import type { AuthHeader, OAuth2Scopes } from "twitter-api-sdk";

// Import entire types namespace
import { types } from "twitter-api-sdk";

// Use types for parameters and responses
const params: types.TwitterParams<operations["findTweetsById"]> = {
  ids: "20",
};
```

--------------------------------

### GET /2/tweets/counts/recent

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get counts of recent tweets matching query.

```APIDOC
## GET /2/tweets/counts/recent

### Description
Get counts of recent tweets matching query.

### Method
GET

### Endpoint
/2/tweets/counts/recent

### Parameters
#### Query Parameters
- **query** (string) - Required
- **granularity** (string) - Optional
- **max_results** (number) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated count data
```

--------------------------------

### Clone Repository

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Clone the SDK source code.

```bash
git clone https://github.com/twitterdev/twitter-api-typescript-sdk
```

--------------------------------

### GET /2/users/{id}/muting

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get user's muted users.

```APIDOC
## GET /2/users/{id}/muting

### Description
Get user's muted users.

### Method
GET

### Endpoint
/2/users/{id}/muting

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated muted users
```

--------------------------------

### GET /2/users/{id}/blocking

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Get user's blocked users.

```APIDOC
## GET /2/users/{id}/blocking

### Description
Get user's blocked users.

### Method
GET

### Endpoint
/2/users/{id}/blocking

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated blocked users
```

--------------------------------

### Run Generation Script

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Generate SDK files from OpenAPI specifications.

```bash
yarn generate 1.0.0
```

```bash
yarn generate 1.0.0 --specFile ~/path/to/file/openapi.json
```

--------------------------------

### Initialize Twitter API Client

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/README.md

Demonstrates how to initialize the SDK client using either a bearer token or an OAuth2User authentication provider.

```typescript
import { Client, auth } from "twitter-api-sdk";

// Bearer token authentication
const client = new Client("your-bearer-token");

// OAuth2 authentication
const authClient = new auth.OAuth2User({
  client_id: "your-client-id",
  client_secret: "your-client-secret",
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
});

const client = new Client(authClient);
```

--------------------------------

### Authenticate with the SDK

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/00_START_HERE.md

Initializes the client using either a Bearer token or OAuth2 user authentication.

```typescript
import { Client, auth } from "twitter-api-sdk";

// Bearer token
const client = new Client(process.env.BEARER_TOKEN);

// OAuth2
const authClient = new auth.OAuth2User({
  client_id: "...",
  client_secret: "...",
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read"],
});
```

--------------------------------

### Client Constructor

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/configuration.md

Initializes the main Twitter API client with authentication and optional request configurations.

```APIDOC
## Client Constructor

### Signature
`new Client(auth: string | AuthClient, requestOptions?: Partial<RequestOptions>)`

### Parameters
- **auth** (string | AuthClient) - Required - Bearer token string or an AuthClient instance.
- **requestOptions** (Partial<RequestOptions>) - Optional - Configuration object for requests.

### RequestOptions Fields
- **auth** (AuthClient) - Optional - Authentication client.
- **endpoint** (string) - Optional - API endpoint.
- **params** (Record<string, any>) - Optional - Query parameters.
- **request_body** (Record<string, any>) - Optional - Request body data.
- **method** (string) - Optional - HTTP method.
- **max_retries** (number) - Optional - Number of retries for failed requests.
- **base_url** (string) - Optional - Custom base URL.
- **headers** (Record<string, string>) - Optional - Custom request headers.
```

--------------------------------

### Bearer Token Usage Patterns

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/authentication.md

Common ways to initialize the client with a bearer token.

```typescript
const client = new Client("YOUR_BEARER_TOKEN");
```

```typescript
import { Client, auth } from "twitter-api-sdk";

const authClient = new auth.OAuth2Bearer(process.env.BEARER_TOKEN);
const client = new Client(authClient);
```

--------------------------------

### GET /2/tweets/compliance/stream

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Streams tweet compliance data.

```APIDOC
## GET /2/tweets/compliance/stream

### Description
Stream tweet compliance data.

### Method
GET

### Endpoint
/2/tweets/compliance/stream
```

--------------------------------

### GET /2/compliance/jobs

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves a list of compliance jobs.

```APIDOC
## GET /2/compliance/jobs

### Description
Get compliance jobs.

### Method
GET

### Endpoint
/2/compliance/jobs

### Parameters
#### Query Parameters
- **type** (string) - Optional - tweets or users
- **status** (string) - Optional - Job status
```

--------------------------------

### Build Query String with Type Definitions

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/utilities.md

Demonstrates defining a query object and converting it to a query string using buildQueryString.

```typescript
// Query object (for buildQueryString)
type QueryObject = Record<string, any>;

// Example strongly-typed parameter object
interface SearchParams {
  query: string;
  max_results?: number;
  [key: string]: string | number | undefined;
}

// Convert to query string
const params: SearchParams = {
  query: "hello",
  max_results: 100,
};
const queryString = buildQueryString(params);
```

--------------------------------

### GET /2/tweets/search/all

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Search all tweets (requires archive access).

```APIDOC
## GET /2/tweets/search/all

### Description
Search all tweets (requires archive access).

### Method
GET

### Endpoint
/2/tweets/search/all

### Parameters
#### Query Parameters
- **query** (string) - Required
- **start_time** (string) - Optional
- **end_time** (string) - Optional
- **max_results** (number) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated historical tweet results
```

--------------------------------

### constructor(bearer_token: string)

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/oauth2bearer.md

Initializes a new instance of the OAuth2Bearer provider with a static bearer token.

```APIDOC
## constructor(bearer_token: string)

### Description
Initializes the OAuth2Bearer authentication provider.

### Parameters
- **bearer_token** (string) - Required - The bearer token for Twitter API authentication.
```

--------------------------------

### Initialize OAuth2User Client

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/authentication.md

Configures the OAuth2User client for user-context authentication. Requires client credentials and defined scopes.

```typescript
import { Client, auth } from "twitter-api-sdk";

const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);
```

```typescript
import { auth } from "twitter-api-sdk";

const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,  // Only for confidential clients
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});
```

--------------------------------

### GET /2/tweets/search/recent

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Search tweets from last 7 days.

```APIDOC
## GET /2/tweets/search/recent

### Description
Search tweets from last 7 days.

### Method
GET

### Endpoint
/2/tweets/search/recent

### Parameters
#### Query Parameters
- **query** (string) - Required
- **max_results** (number) - Optional
- **pagination_token** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated tweet results
```

--------------------------------

### GET /2/compliance/jobs/{id}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves details for a specific compliance job.

```APIDOC
## GET /2/compliance/jobs/{id}

### Description
Get job details.

### Method
GET

### Endpoint
/2/compliance/jobs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The job ID
```

--------------------------------

### auth.OAuth2User

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/authentication.md

Initializes the OAuth2 client for user-context authentication.

```APIDOC
## auth.OAuth2User

### Description
Initializes the OAuth2User client to handle the authorization code flow.

### Constructor Parameters
- **client_id** (string) - Required - OAuth 2.0 Client ID from the Twitter Developer Portal.
- **client_secret** (string) - Optional - Client secret for confidential clients.
- **callback** (string) - Required - The callback URL registered in the Twitter Developer Portal.
- **scopes** (string[]) - Required - List of requested permissions (e.g., "tweet.read", "users.read", "offline.access").
```

--------------------------------

### GET /2/lists/{id}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves details for a specific Twitter List.

```APIDOC
## GET /2/lists/{id}

### Description
Get list details.

### Method
GET

### Endpoint
/2/lists/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **data** (object) - List object
```

--------------------------------

### client.compliance.createBatchComplianceJob

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/QUICK_REFERENCE.md

Initiates a new batch compliance job.

```APIDOC
## client.compliance.createBatchComplianceJob(params)

### Description
Creates a new batch compliance job for processing data.

### Parameters
- **params** (object) - Required
  - **type** (string) - Required - The type of compliance job (e.g., 'tweets').
  - **upload_url** (string) - Required - The URL containing the IDs to process.
```

--------------------------------

### GET /2/spaces/search

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Searches for Twitter Spaces based on query parameters.

```APIDOC
## GET /2/spaces/search

### Description
Search for spaces.

### Method
GET

### Endpoint
/2/spaces/search

### Parameters
#### Query Parameters
- **query** (string) - Required
- **state** (string) - Optional
- **max_results** (number) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated matching spaces
```

--------------------------------

### Create Public Auth Client

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/README.md

Initialize an OAuth2 client for public applications.

```typescript
const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  callback: "http://127.0.0.1:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);
```

--------------------------------

### GET /2/spaces

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves information for multiple Twitter Spaces by their IDs.

```APIDOC
## GET /2/spaces

### Description
Get spaces by IDs.

### Method
GET

### Endpoint
/2/spaces

### Parameters
#### Query Parameters
- **ids** (string) - Required
- **fields** (string) - Optional
- **expansions** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Space objects
```

--------------------------------

### Query String Parameter Handling

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/utilities.md

Demonstrates how buildQueryString processes various data types, noting that falsy values like 0, empty strings, null, and undefined are skipped.

```typescript
// Array values
buildQueryString({
  ids: ["20", "21"],
});
// Note: Arrays are converted to comma-separated strings by caller
// Result depends on how arrays are stringified

// Boolean values
buildQueryString({
  active: true,
  archived: false,
});
// Result: "active=true"  (false values skipped)

// Zero and empty string
buildQueryString({
  count: 0,
  prefix: "",
});
// Result: "" (both are falsy and skipped)

// Null and undefined
buildQueryString({
  pagination_token: null,
  limit: undefined,
});
// Result: "" (both are falsy and skipped)

// Nested objects (converted to string by JavaScript)
buildQueryString({
  config: { nested: "value" },
});
// Result: "config=%5Bobject%20Object%5D"
```

--------------------------------

### GET /2/users/{id}/list_memberships

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves lists that a specific user is a member of.

```APIDOC
## GET /2/users/{id}/list_memberships

### Description
Get lists user is member of.

### Method
GET

### Endpoint
/2/users/{id}/list_memberships

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated memberships
```

--------------------------------

### Request Building Integration

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/utilities.md

Shows how to integrate buildQueryString into URL construction for API requests.

```typescript
// src/request.ts usage
const url = new URL(base_url + endpoint);
url.search = buildQueryString(query);

// Example: GET /2/tweets?ids=20&tweet.fields=author_id
```

--------------------------------

### GET /2/users/{id}/followed_lists

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves lists followed by a specific user.

```APIDOC
## GET /2/users/{id}/followed_lists

### Description
Get lists followed by user.

### Method
GET

### Endpoint
/2/users/{id}/followed_lists

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated followed lists
```

--------------------------------

### Initialize OAuth2 User Authentication

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/QUICK_REFERENCE.md

Configure the OAuth2 client with credentials, callback URL, and required scopes.

```typescript
import { Client, auth } from "twitter-api-sdk";

const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);
```

--------------------------------

### GET /2/users/{id}/pinned_lists

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves lists pinned by a specific user.

```APIDOC
## GET /2/users/{id}/pinned_lists

### Description
Get user's pinned lists.

### Method
GET

### Endpoint
/2/users/{id}/pinned_lists

### Parameters
#### Path Parameters
- **id** (string) - Required

### Response
#### Success Response (200)
- **data** (array) - Pinned lists
```

--------------------------------

### GET /2/users/{id}/owned_lists

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves lists owned by a specific user.

```APIDOC
## GET /2/users/{id}/owned_lists

### Description
Get lists owned by user.

### Method
GET

### Endpoint
/2/users/{id}/owned_lists

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated lists
```

--------------------------------

### OAuth2UserOptions

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/types.md

Configuration interface for initializing an OAuth2User authentication client.

```APIDOC
## Interface: OAuth2UserOptions

### Description
Configuration object used to initialize the OAuth2User authentication client.

### Fields
- **client_id** (string) - Required - Client ID from Twitter Developer Portal
- **client_secret** (string) - Optional - Required for confidential clients (server-side apps)
- **callback** (string) - Required - Redirect URI that matches developer portal configuration
- **scopes** (OAuth2Scopes[]) - Required - Array of permission scopes
- **request_options** (Partial<RequestOptions>) - Optional - Custom request options for token endpoint calls
- **token** (Token) - Optional - Pre-existing token for session restoration
```

--------------------------------

### GET /2/lists/{id}/members

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves members of a specific Twitter List.

```APIDOC
## GET /2/lists/{id}/members

### Description
Get list members.

### Method
GET

### Endpoint
/2/lists/{id}/members

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated users
```

--------------------------------

### Complete OAuth2 Flow Implementation

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/oauth2user.md

Demonstrates the full OAuth2 authorization code flow including login, callback handling, API requests, and token revocation.

```typescript
import express from "express";
import { Client, auth } from "twitter-api-sdk";

const app = express();
const STATE = "random-state-value";

const authClient = new auth.OAuth2User({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  callback: "http://localhost:3000/callback",
  scopes: ["tweet.read", "users.read", "offline.access"],
});

const client = new Client(authClient);

// Step 1: User clicks "Login"
app.get("/login", (req, res) => {
  const authUrl = authClient.generateAuthURL({
    state: STATE,
    code_challenge_method: "s256",
  });
  res.redirect(authUrl);
});

// Step 2: Twitter redirects back with code
app.get("/callback", async (req, res) => {
  const { code, state } = req.query;
  if (state !== STATE) return res.status(400).send("Invalid state");
  
  await authClient.requestAccessToken(code);
  res.redirect("/dashboard");
});

// Step 3: Make API calls with automatic token refresh
app.get("/dashboard", async (req, res) => {
  const user = await client.users.findMyUser();
  res.json(user);
});

// Step 4: User logs out
app.get("/logout", async (req, res) => {
  await authClient.revokeAccessToken();
  res.redirect("/");
});

app.listen(3000);
```

--------------------------------

### GET /2/spaces/{id}

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves details for a single Twitter Space by its ID.

```APIDOC
## GET /2/spaces/{id}

### Description
Get single space by ID.

### Method
GET

### Endpoint
/2/spaces/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **data** (object) - Single space object
```

--------------------------------

### Manage and Interact with Lists

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Shows how to create a list, retrieve tweets from a list, add members, and follow a list using the client.lists interface.

```typescript
// Create a list
const newList = await client.lists.listIdCreate({
  name: "My List",
  description: "Interesting accounts",
});

// Get list tweets
for await (const page of client.lists.listsIdTweets(listId)) {
  console.log(page.data);
}

// Add member to list
await client.lists.listAddMember(listId, { user_id: userId });

// Follow a list
await client.lists.listUserFollow(myUserId, { list_id: listId });
```

--------------------------------

### Get User Timeline

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/QUICK_REFERENCE.md

Iterate through pages of a user's tweets or mentions.

```typescript
// Get user's tweets
for await (const page of client.users.usersIdTweets("user-id")) {
  console.log(page.data);  // Array of tweets
}

// Get user's mentions
for await (const page of client.users.usersIdMentions("user-id")) {
  console.log(page.data);
}
```

--------------------------------

### client.general

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/client.md

Miscellaneous methods for accessing API metadata.

```APIDOC
## client.general

### Description
Provides miscellaneous endpoints for accessing API metadata.

### Methods
- `getOpenApiSpec()`: Gets the OpenAPI specification.
```

--------------------------------

### GET /2/openapi.json

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves the full OpenAPI specification for the Twitter API in JSON format.

```APIDOC
## GET /2/openapi.json

### Description
Retrieves the full OpenAPI specification for the Twitter API in JSON format.

### Method
GET

### Endpoint
/2/openapi.json

### Response
#### Success Response (200)
- **spec** (JSON) - The full OpenAPI specification object.
```

--------------------------------

### Manage Bookmarks

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/QUICK_REFERENCE.md

Retrieve, add, or remove bookmarks for a user.

```typescript
// Get bookmarks
for await (const page of client.bookmarks.getUsersIdBookmarks("user-id")) {
  console.log(page.data);
}

// Add bookmark
await client.bookmarks.postUsersIdBookmarks("user-id", { tweet_id: "tweet-id" });

// Remove bookmark
await client.bookmarks.usersIdBookmarksDelete("user-id", "tweet-id");
```

--------------------------------

### GET /2/users/{id}/bookmarks

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves a list of bookmarked tweets for a specific user.

```APIDOC
## GET /2/users/{id}/bookmarks

### Description
Get user's bookmarked tweets.

### Method
GET

### Endpoint
/2/users/{id}/bookmarks

### Parameters
#### Path Parameters
- **id** (string) - Required - The user ID

### Response
#### Success Response (200)
- **data** (array) - Paginated bookmarked tweets
```

--------------------------------

### client.bookmarks

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/client.md

Methods for retrieving and managing user bookmarks.

```APIDOC
## client.bookmarks

### Description
Provides access to bookmark endpoints for retrieving and managing user bookmarks.

### Methods
- `getUsersIdBookmarks(userId)`: Gets bookmarked tweets.
- `postUsersIdBookmarks(userId, params)`: Adds a tweet to bookmarks.
- `usersIdBookmarksDelete(userId, tweetId)`: Removes a bookmark.
```

--------------------------------

### GET /2/lists/{id}/followers

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves users following a specific Twitter List.

```APIDOC
## GET /2/lists/{id}/followers

### Description
Get users following list.

### Method
GET

### Endpoint
/2/lists/{id}/followers

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated followers
```

--------------------------------

### GET /2/lists/{id}/tweets

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/endpoints.md

Retrieves tweets contained within a specific Twitter List.

```APIDOC
## GET /2/lists/{id}/tweets

### Description
Get tweets in a list.

### Method
GET

### Endpoint
/2/lists/{id}/tweets

### Parameters
#### Path Parameters
- **id** (string) - Required

#### Query Parameters
- **pagination** (string) - Optional

### Response
#### Success Response (200)
- **data** (array) - Paginated tweets
```

--------------------------------

### Implement Rate Limiting Strategies

Source: https://github.com/xdevplatform/twitter-api-typescript-sdk/blob/main/_autodocs/api-reference/request-layer.md

Compare automatic SDK retries with manual implementation using custom backoff logic.

```typescript
// Option 1: Let SDK auto-retry
const client = new Client(token, { max_retries: 3 });

// Option 2: Manual retry with backoff
async function withRetry(fn, maxAttempts = 3) {
  for (let i = 1; i <= maxAttempts; i++) {
    try {
      return await fn();
    } catch (error) {
      if (error.status === 429 && i < maxAttempts) {
        const resetTime = error.headers["x-rate-limit-reset"];
        const waitMs = resetTime * 1000 - Date.now();
        await new Promise(r => setTimeout(r, waitMs));
      } else {
        throw error;
      }
    }
  }
}
```
Tokens:
Raw