> ## 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

> Instale e use a biblioteca cliente oficial TypeScript XDK para a X API v2, com autenticação, respostas tipadas, paginação e exemplos de streaming.

O [TypeScript XDK](https://github.com/xdevplatform/twitter-api-typescript-sdk) é a biblioteca cliente oficial para a X API v2. Type safety completo, paginação automática e streaming orientado a eventos.

<Card title="Repositório no GitHub" icon="github" href="https://github.com/xdevplatform/twitter-api-typescript-sdk">
  Código-fonte, issues e releases.
</Card>

***

## Instalação

<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>

Requer Node.js 16+ e TypeScript 4.5+ (se estiver usando TypeScript).

***

## Início rápido

```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);
```

***

## Principais recursos

| Recurso                       | Descrição                                                            |
| :---------------------------- | :------------------------------------------------------------------- |
| **Type safety**               | Definições TypeScript completas para todos os endpoints e parâmetros |
| **Autenticação**              | Bearer Token, OAuth 2.0 com PKCE e OAuth 1.0a                        |
| **Paginação automática**      | Suporte a iteração assíncrona para endpoints paginados               |
| **Streaming**                 | Streaming orientado a eventos com reconexão automática               |
| **Cobertura completa da API** | Users, Posts, Lists, Bookmarks, Communities e muito mais             |

***

## Autenticação

<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 comuns

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

***

## Saiba mais

<CardGroup cols={2}>
  <Card title="Instalação" icon="download" href="/xdks/typescript/install">
    Gerenciadores de pacote, configuração do TypeScript e requisitos.
  </Card>

  <Card title="Autenticação" icon="key" href="/xdks/typescript/authentication">
    Guia detalhado para todos os métodos de autenticação.
  </Card>

  <Card title="Paginação" icon="arrows-left-right" href="/xdks/typescript/pagination">
    Iteração assíncrona e respostas paginadas.
  </Card>

  <Card title="Streaming" icon="satellite-dish" href="/xdks/typescript/streaming">
    Streaming orientado a eventos com reconexão.
  </Card>

  <Card title="Referência da API" icon="book" href="/xdks/typescript/reference/modules">
    Referência completa de clientes, interfaces e tipos.
  </Card>
</CardGroup>

Para ver exemplos de código, confira o [repositório de samples](https://github.com/xdevplatform/samples/tree/main/javascript).