Guia rápido

Este guia mostra como consultar informações de List usando os endpoints de consulta de List.

Pré-requisitosAntes de começar, você precisará de:

Uma conta de desenvolvedor com um App aprovado
O Bearer Token do seu App

Obter uma List por ID

Recupere os detalhes de uma List específica:

cURL

curl "https://api.x.com/2/lists/1234567890?\
list.fields=description,owner_id,member_count,follower_count,private,created_at" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Obter uma List por ID
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id", "member_count", "follower_count", "private", "created_at"]
)

print(f"List: {response.data.name}")
print(f"Members: {response.data.member_count}")

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

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

// Obter uma List por ID
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id", "member_count", "follower_count", "private", "created_at"],
});

console.log(`List: ${response.data?.name}`);
console.log(`Members: ${response.data?.member_count}`);

Resposta

Exemplo de resposta

{
  "data": {
    "id": "1234567890",
    "name": "Tech News",
    "description": "Top tech journalists and publications",
    "owner_id": "2244994945",
    "private": false,
    "member_count": 50,
    "follower_count": 1250,
    "created_at": "2023-01-15T10:00:00.000Z"
  }
}

Obter Lists de propriedade de um usuário

Recupere todas as Lists de propriedade de um usuário específico:

cURL

curl "https://api.x.com/2/users/2244994945/owned_lists?\
list.fields=description,member_count,follower_count&\
max_results=100" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Obter Lists de propriedade de um usuário com paginação
for page in client.lists.get_owned_lists(
    "2244994945",
    list_fields=["description", "member_count", "follower_count"],
    max_results=100
):
    for lst in page.data:
        print(f"{lst.name} - {lst.member_count} members")

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

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

// Obter Lists de propriedade de um usuário com paginação
const paginator = client.lists.getOwnedLists("2244994945", {
  listFields: ["description", "member_count", "follower_count"],
  maxResults: 100,
});

for await (const page of paginator) {
  page.data?.forEach((lst) => {
    console.log(`${lst.name} - ${lst.member_count} members`);
  });
}

Resposta

Exemplo de resposta

{
  "data": [
    {
      "id": "1234567890",
      "name": "Tech News",
      "description": "Top tech journalists",
      "member_count": 50,
      "follower_count": 1250
    },
    {
      "id": "9876543210",
      "name": "Developer Tools",
      "description": "Useful tools for developers",
      "member_count": 25,
      "follower_count": 500
    }
  ],
  "meta": {
    "result_count": 2
  }
}

Incluir informações do proprietário

Expanda os dados de usuário do proprietário:

cURL

curl "https://api.x.com/2/lists/1234567890?\
list.fields=description,owner_id&\
expansions=owner_id&\
user.fields=username,verified" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Obter List com informações do proprietário
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id"],
    expansions=["owner_id"],
    user_fields=["username", "verified"]
)

print(f"List: {response.data.name}")
# Informações do proprietário estão em response.includes.users

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

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

// Obter List com informações do proprietário
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id"],
  expansions: ["owner_id"],
  userFields: ["username", "verified"],
});

console.log(`List: ${response.data?.name}`);
// Informações do proprietário estão em response.includes?.users

Resposta com expansion

Exemplo de resposta

{
  "data": {
    "id": "1234567890",
    "name": "Tech News",
    "description": "Top tech journalists",
    "owner_id": "2244994945"
  },
  "includes": {
    "users": [
      {
        "id": "2244994945",
        "username": "XDevelopers",
        "verified": true
      }
    ]
  }
}

Fields disponíveis

Field	Descrição
`description`	Descrição da List
`owner_id`	User ID do proprietário
`private`	Se a List é privada
`member_count`	Número de membros
`follower_count`	Número de seguidores
`created_at`	Data de criação da List

Próximos passos

List Posts

Obtenha Posts de uma List

Membros da List

Obtenha membros de uma List

Gerenciar Lists

Crie e atualize Lists

Referência da API

Documentação completa do endpoint

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Guia rápido

Obter uma List por ID

Resposta

Obter Lists de propriedade de um usuário

Resposta

Incluir informações do proprietário

Resposta com expansion

Fields disponíveis

Próximos passos

List Posts

Membros da List

Gerenciar Lists

Referência da API

​Obter uma List por ID

​Resposta

​Obter Lists de propriedade de um usuário

​Resposta

​Incluir informações do proprietário

​Resposta com expansion

​Fields disponíveis

​Próximos passos

List Posts

Membros da List

Gerenciar Lists

Referência da API

Obter uma List por ID

Resposta

Obter Lists de propriedade de um usuário

Resposta

Incluir informações do proprietário

Resposta com expansion

Fields disponíveis

Próximos passos