Démarrage rapide

Ce guide vous explique comment consulter les informations d’une Liste à l’aide des endpoints de recherche de Liste.

PrérequisAvant de commencer, vous aurez besoin de :

d’un compte développeur avec une App approuvée
du jeton Bearer de votre App

Obtenir une Liste par ID

Récupérez les détails d’une Liste spécifique :

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

# Obtenir une Liste par ID
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id", "member_count", "follower_count", "private", "created_at"]
)

print(f"Liste : {response.data.name}")
print(f"Membres : {response.data.member_count}")

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

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

// Obtenir une Liste par ID
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id", "member_count", "follower_count", "private", "created_at"],
});

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

Réponse

{
  "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"
  }
}

Obtenir les Listes détenues par un utilisateur

Obtenez toutes les Listes détenues par un utilisateur donné :

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

# Obtenir les Listes détenues par un utilisateur avec pagination
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" });

// Obtenir les Listes détenues par un utilisateur avec pagination
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`);
  });
}

Réponse

{
  "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
  }
}

Inclure les informations du propriétaire

Étendez les données de l’utilisateur propriétaire :

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

# Récupérer la liste avec les informations du propriétaire
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id"],
    expansions=["owner_id"],
    user_fields=["username", "verified"]
)

print(f"List: {response.data.name}")
# Les informations du propriétaire se trouvent dans response.includes.users

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

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

// Récupérer la liste avec les informations du propriétaire
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id"],
  expansions: ["owner_id"],
  userFields: ["username", "verified"],
});

console.log(`List: ${response.data?.name}`);
// Les informations du propriétaire se trouvent dans response.includes?.users

Réponse avec expansions

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

Champs disponibles

Champ	Description
`description`	Description de la Liste
`owner_id`	ID utilisateur du propriétaire
`private`	Indique si la Liste est privée
`member_count`	Nombre de membres
`follower_count`	Nombre d’abonnés
`created_at`	Date de création de la Liste

Prochaines étapes

Publications d’une liste

Obtenir les publications d’une liste

Membres d’une liste

Obtenir les membres d’une liste

Gérer les listes

Créer et mettre à jour des listes

Référence de l’API

Documentation complète de l’endpoint

Vue d’ensemble

Publications

Utilisateurs

Messages privés

Mentions J’aime

Listes

Espaces

Communautés

Notes de la communauté

Tendances

Actualités

Médias

Activité sur X

Utilisation

Connexions de flux

Conformité

Enterprise v2

Flux des J’aime

GNIP 2.0

Démarrage rapide

Obtenir une Liste par ID

Réponse

Obtenir les Listes détenues par un utilisateur

Réponse

Inclure les informations du propriétaire

Réponse avec expansions

Champs disponibles

Prochaines étapes

Publications d’une liste

Membres d’une liste

Gérer les listes

Référence de l’API