> ## Documentation Index
> Fetch the complete documentation index at: https://docs.x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript XDK

> Instala y usa la biblioteca cliente oficial TypeScript XDK para la X API v2, con ejemplos de autenticación, respuestas tipadas, paginación y streaming.

El [TypeScript XDK](https://github.com/xdevplatform/twitter-api-typescript-sdk) es la biblioteca cliente oficial para la X API v2. Seguridad de tipos completa, paginación automática y streaming basado en eventos.

<Card title="Repositorio de GitHub" icon="github" href="https://github.com/xdevplatform/twitter-api-typescript-sdk">
  Código fuente, issues y releases.
</Card>

***

## Instalación

<CodeGroup>
  ```bash npm theme={null}
  npm install @xdevplatform/xdk
  ```

  ```bash yarn theme={null}
  yarn add @xdevplatform/xdk
  ```

  ```bash pnpm theme={null}
  pnpm add @xdevplatform/xdk
  ```
</CodeGroup>

Requiere Node.js 16+ y TypeScript 4.5+ (si usas TypeScript).

***

## Guía rápida

```typescript theme={null}
import { Client } from '@xdevplatform/xdk';

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

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

***

## Características clave

| Característica                   | Descripción                                                                |
| :------------------------------- | :------------------------------------------------------------------------- |
| **Seguridad de tipos**           | Definiciones completas de TypeScript para todos los endpoints y parámetros |
| **Autenticación**                | Bearer Token, OAuth 2.0 con PKCE y OAuth 1.0a                              |
| **Paginación automática**        | Soporte de iteración asíncrona para endpoints paginados                    |
| **Streaming**                    | Streaming basado en eventos con reconexión automática                      |
| **Cobertura completa de la API** | Users, Posts, Lists, Bookmarks, Communities y más                          |

***

## Autenticación

<Tabs>
  <Tab title="Bearer Token">
    ```typescript theme={null}
    import { Client } from '@xdevplatform/xdk';

    const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });
    ```
  </Tab>

  <Tab title="OAuth 2.0">
    ```typescript theme={null}
    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');

    const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
    const client = new Client({ accessToken: tokens.access_token });
    ```
  </Tab>

  <Tab title="OAuth 1.0a">
    ```typescript theme={null}
    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 });
    ```
  </Tab>
</Tabs>

***

## Métodos comunes

| Categoría  | Método                           |
| :--------- | :------------------------------- |
| **Posts**  | `client.posts.search()`          |
| **Users**  | `client.users.getMe()`           |
| **Spaces** | `client.spaces.findSpaceById()`  |
| **Lists**  | `client.lists.getList()`         |
| **DMs**    | `client.directMessages.lookup()` |

***

## Más información

<CardGroup cols={2}>
  <Card title="Instalación" icon="download" href="/xdks/typescript/install">
    Gestores de paquetes, configuración de TypeScript y requisitos.
  </Card>

  <Card title="Autenticación" icon="key" href="/xdks/typescript/authentication">
    Guía detallada para todos los métodos de autenticación.
  </Card>

  <Card title="Paginación" icon="arrows-left-right" href="/xdks/typescript/pagination">
    Iteración asíncrona y respuestas paginadas.
  </Card>

  <Card title="Streaming" icon="satellite-dish" href="/xdks/typescript/streaming">
    Streaming basado en eventos con reconexión.
  </Card>

  <Card title="Referencia de la API" icon="book" href="/xdks/typescript/reference/modules">
    Referencia completa del cliente, interfaces y tipos.
  </Card>
</CardGroup>

Para ver ejemplos de código, consulta el [repositorio de ejemplos](https://github.com/xdevplatform/samples/tree/main/javascript).