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

# Guia de integração

> Este guia cobre os principais conceitos necessários para integrar os endpoints de consulta de List ao seu. Referência para o nível standard da X API v2 sobre list lookup.

export const Button = ({href, children}) => {
  return <div className="not-prose">
    <a href={href}>
      <button className="x-btn">
        <span>{children}</span>
        <svg width="3" height="24" viewBox="0 -9 3 24" class="h-6 rotate-0 overflow-visible"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg>
      </button>
    </a>
  </div>;
};

Este guia cobre os principais conceitos necessários para integrar os endpoints de consulta de List à sua aplicação.

***

## Autenticação

Os endpoints de consulta de List suportam vários métodos de autenticação:

| Método                                                                                                                         | Melhor para              | Acesso a Lists privadas? |
| :----------------------------------------------------------------------------------------------------------------------------- | :----------------------- | :----------------------- |
| [OAuth 2.0 App-Only](/resources/fundamentals/authentication#oauth-2-0)                                                         | Dados públicos de List   | Não                      |
| [OAuth 2.0 Authorization Code with PKCE](/resources/fundamentals/authentication#oauth-2-0-authorization-code-flow-with-pkce-2) | Apps voltados ao usuário | Sim (próprias/seguidas)  |
| [OAuth 1.0a User Context](/resources/fundamentals/authentication)                                                              | Integrações legadas      | Sim (próprias/seguidas)  |

### Exemplo de requisição

<CodeGroup dropdown>
  ```bash cURL theme={null}
  curl "https://api.x.com/2/lists/84839422?\
  list.fields=description,member_count,follower_count,private" \
    -H "Authorization: Bearer $BEARER_TOKEN"
  ```

  ```python Python SDK theme={null}
  from xdk import Client

  client = Client(bearer_token="YOUR_BEARER_TOKEN")

  # Obter uma List por ID
  response = client.lists.get(
      list_id="84839422",
      list_fields=["description", "member_count", "follower_count", "private"]
  )
  print(response.data)
  ```

  ```javascript JavaScript SDK theme={null}
  import { Client } from "@xdevplatform/xdk";

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

  const response = await client.lists.get("84839422", {
    listFields: ["description", "member_count", "follower_count", "private"],
  });
  console.log(response.data);
  ```
</CodeGroup>

***

## Visão geral dos endpoints

| Método | Endpoint                                                   | Descrição                                |
| :----- | :--------------------------------------------------------- | :--------------------------------------- |
| GET    | [`/2/lists/:id`](/x-api/lists/get-list-by-id)              | Obter List por ID                        |
| GET    | [`/2/users/:id/owned_lists`](/x-api/users/get-owned-lists) | Obter Lists de propriedade de um usuário |

***

## Fields e expansions

### Resposta padrão

```json theme={null}
{
  "data": {
    "id": "84839422",
    "name": "Tech News"
  }
}
```

### Fields disponíveis

<Accordion title="list.fields">
  | Field            | Descrição                    |
  | :--------------- | :--------------------------- |
  | `created_at`     | Timestamp de criação da List |
  | `description`    | Descrição da List            |
  | `follower_count` | Número de seguidores         |
  | `member_count`   | Número de membros            |
  | `owner_id`       | User ID do proprietário      |
  | `private`        | Se a List é privada          |
</Accordion>

<Accordion title="user.fields (requer expansion owner_id)">
  | Field               | Descrição                             |
  | :------------------ | :------------------------------------ |
  | `username`          | @handle do proprietário               |
  | `name`              | Nome de exibição do proprietário      |
  | `verified`          | Status de verificação do proprietário |
  | `profile_image_url` | URL do avatar do proprietário         |
</Accordion>

### Exemplo com expansions

<CodeGroup dropdown>
  ```bash cURL theme={null}
  curl "https://api.x.com/2/lists/84839422?\
  list.fields=description,member_count,follower_count,owner_id&\
  expansions=owner_id&\
  user.fields=username,verified" \
    -H "Authorization: Bearer $BEARER_TOKEN"
  ```

  ```python title="Python SDK" lines wrap icon="python" theme={null}
  from xdk import Client

  client = Client(bearer_token="YOUR_BEARER_TOKEN")

  # Obter List com expansion de proprietário
  response = client.lists.get(
      list_id="84839422",
      list_fields=["description", "member_count", "follower_count", "owner_id"],
      expansions=["owner_id"],
      user_fields=["username", "verified"]
  )

  print(response.data)
  print(response.includes)  # Contém o objeto de usuário do proprietário
  ```

  ```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
  import { Client } from "@xdevplatform/xdk";

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

  const response = await client.lists.get("84839422", {
    listFields: ["description", "member_count", "follower_count", "owner_id"],
    expansions: ["owner_id"],
    userFields: ["username", "verified"],
  });

  console.log(response.data);
  console.log(response.includes); // Contém o objeto de usuário do proprietário
  ```
</CodeGroup>

### Resposta com expansion

```json title="Exemplo de resposta" lines wrap icon="https://mintcdn.com/x-preview/Vn2KEkZaPF9LiPi3/icons/xds/icon-brackets.svg?fit=max&auto=format&n=Vn2KEkZaPF9LiPi3&q=85&s=ed2428e77bab43e57800e1a590e982fa" theme={null}
{
  "data": {
    "id": "84839422",
    "name": "Tech News",
    "description": "Top tech journalists",
    "member_count": 50,
    "follower_count": 1250,
    "owner_id": "2244994945"
  },
  "includes": {
    "users": [
      {
        "id": "2244994945",
        "username": "XDevelopers",
        "verified": true
      }
    ]
  }
}
```

<Card title="Guia de fields e expansions" icon="sliders" href="/x-api/fundamentals/fields">
  Saiba mais sobre como personalizar as respostas
</Card>

***

## Paginação

Ao recuperar Lists de propriedade, os resultados são paginados:

<CodeGroup dropdown>
  ```bash cURL theme={null}
  # Primeira requisição
  curl "https://api.x.com/2/users/123/owned_lists?max_results=100" \
    -H "Authorization: Bearer $BEARER_TOKEN"

  # Requisição subsequente com token de paginação
  curl "https://api.x.com/2/users/123/owned_lists?max_results=100&pagination_token=NEXT_TOKEN" \
    -H "Authorization: Bearer $BEARER_TOKEN"
  ```

  ```python title="Python SDK" lines wrap icon="python" theme={null}
  from xdk import Client

  client = Client(bearer_token="YOUR_BEARER_TOKEN")

  # O SDK trata a paginação automaticamente
  all_lists = []

  for page in client.lists.get_user_owned_lists(user_id="123", max_results=100):
      if page.data:
          all_lists.extend(page.data)

  print(f"Found {len(all_lists)} lists")
  ```

  ```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
  import { Client } from "@xdevplatform/xdk";

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

  async function getAllOwnedLists(userId) {
    const allLists = [];

    // O SDK trata a paginação automaticamente
    const paginator = client.lists.getUserOwnedLists(userId, { maxResults: 100 });

    for await (const page of paginator) {
      if (page.data) {
        allLists.push(...page.data);
      }
    }

    return allLists;
  }

  // Uso
  const lists = await getAllOwnedLists("123");
  console.log(`Found ${lists.length} lists`);
  ```
</CodeGroup>

<Card title="Guia de paginação" icon="https://mintcdn.com/x-preview/Vn2KEkZaPF9LiPi3/icons/xds/icon-arrow-right.svg?fit=max&auto=format&n=Vn2KEkZaPF9LiPi3&q=85&s=88e933002782dbdeb204043cedef033e" href="/x-api/fundamentals/pagination" width="24" height="24" data-path="icons/xds/icon-arrow-right.svg">
  Saiba mais sobre paginação
</Card>

***

## Lists privadas

* Lists privadas só são visíveis para o proprietário
* Você deve se autenticar como proprietário para recuperar os detalhes de uma List privada
* O field `private` indica se uma List é privada

***

## Tratamento de erros

| Status | Erro                | Solução                           |
| :----- | :------------------ | :-------------------------------- |
| 400    | Requisição inválida | Verifique o formato do ID da List |
| 401    | Não autorizado      | Verifique a autenticação          |
| 403    | Proibido            | A List pode ser privada           |
| 404    | Não encontrado      | A List não existe                 |
| 429    | Muitas requisições  | Aguarde e tente novamente         |

***

## Próximos passos

<CardGroup cols={2}>
  <Card title="Guia rápido" icon="https://mintcdn.com/x-preview/oR-aRNyj1BKPJtxM/icons/xds/icon-rocket.svg?fit=max&auto=format&n=oR-aRNyj1BKPJtxM&q=85&s=b978d7a9225de31709efbbed5b84e92d" href="/x-api/lists/list-lookup/quickstart" width="24" height="24" data-path="icons/xds/icon-rocket.svg">
    Faça sua primeira requisição de consulta de List
  </Card>

  <Card title="List Posts" icon="https://mintcdn.com/x-preview/ygI6sSJPehlc0qNT/icons/xds/icon-bulleted-list.svg?fit=max&auto=format&n=ygI6sSJPehlc0qNT&q=85&s=b9bf8323233df59c682b0fec8e3f88d5" href="/x-api/lists/list-tweets/introduction" width="24" height="24" data-path="icons/xds/icon-bulleted-list.svg">
    Obtenha Posts de uma List
  </Card>

  <Card title="Referência da API" icon="https://mintcdn.com/x-preview/ygI6sSJPehlc0qNT/icons/xds/icon-code.svg?fit=max&auto=format&n=ygI6sSJPehlc0qNT&q=85&s=488e23401b19225b89acc0136d242219" href="/x-api/lists/get-list-by-id" width="24" height="24" data-path="icons/xds/icon-code.svg">
    Documentação completa do endpoint
  </Card>

  <Card title="Código de exemplo" icon="github" href="https://github.com/xdevplatform/Twitter-API-v2-sample-code">
    Exemplos de código funcionais
  </Card>
</CardGroup>