Démarrage rapide

Ce guide vous explique comment récupérer des informations sur un Space à l’aide des endpoints de recherche Spaces.

PrérequisAvant de commencer, vous aurez besoin des éléments suivants :

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

Récupérer un Space par id

Récupérez les détails d’un Space spécifique :

cURL

curl "https://api.x.com/2/spaces/1DXxyRYNejbKM?\
space.fields=title,host_ids,participant_count,scheduled_start,state,created_at" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Récupérer un Space par id
response = client.spaces.get(
    "1DXxyRYNejbKM",
    space_fields=["title", "host_ids", "participant_count", "scheduled_start", "state", "created_at"]
)

print(f"Space: {response.data.title}")
print(f"État : {response.data.state}")
print(f"Participants : {response.data.participant_count}")

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

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

// Récupérer un Space par id
const response = await client.spaces.get("1DXxyRYNejbKM", {
  spaceFields: ["title", "host_ids", "participant_count", "scheduled_start", "state", "created_at"],
});

console.log(`Space: ${response.data?.title}`);
console.log(`État : ${response.data?.state}`);
console.log(`Participants : ${response.data?.participant_count}`);

Réponse

{
  "data": {
    "id": "1DXxyRYNejbKM",
    "state": "live",
    "title": "Discussing AI and the Future",
    "host_ids": ["2244994945"],
    "participant_count": 245,
    "created_at": "2024-01-15T09:00:00.000Z"
  }
}

Récupérer plusieurs Spaces

Récupérez plusieurs Spaces en une seule fois :

cURL

curl "https://api.x.com/2/spaces?\
ids=1DXxyRYNejbKM,1YqJDqWYNQDGW&\
space.fields=title,state,participant_count" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Récupérer plusieurs Spaces
response = client.spaces.get_spaces(
    ids=["1DXxyRYNejbKM", "1YqJDqWYNQDGW"],
    space_fields=["title", "state", "participant_count"]
)

for space in response.data:
    print(f"{space.title} - {space.state}")

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

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

// Récupérer plusieurs Spaces
const response = await client.spaces.getSpaces({
  ids: ["1DXxyRYNejbKM", "1YqJDqWYNQDGW"],
  spaceFields: ["title", "state", "participant_count"],
});

response.data?.forEach((space) => {
  console.log(`${space.title} - ${space.state}`);
});

Récupérer des Spaces par créateur

Récupérez les Spaces hébergés par des utilisateurs spécifiques :

cURL

curl "https://api.x.com/2/spaces/by/creator_ids?\
user_ids=2244994945,783214&\
space.fields=title,state,scheduled_start" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Récupérer des Spaces par créateur
response = client.spaces.get_by_creator_ids(
    user_ids=["2244994945", "783214"],
    space_fields=["title", "state", "scheduled_start"]
)

for space in response.data:
    print(f"{space.title} - {space.state}")

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

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

// Récupérer des Spaces par créateur
const response = await client.spaces.getByCreatorIds({
  userIds: ["2244994945", "783214"],
  spaceFields: ["title", "state", "scheduled_start"],
});

response.data?.forEach((space) => {
  console.log(`${space.title} - ${space.state}`);
});

Inclure les informations de l’hôte

Étendre les données de l’utilisateur hôte :

cURL

curl "https://api.x.com/2/spaces/1DXxyRYNejbKM?\
space.fields=title,host_ids,state&\
expansions=host_ids&\
user.fields=username,verified" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Récupérer un Space avec les informations de l’hôte
response = client.spaces.get(
    "1DXxyRYNejbKM",
    space_fields=["title", "host_ids", "state"],
    expansions=["host_ids"],
    user_fields=["username", "verified"]
)

print(f"Space: {response.data.title}")
# Les informations de l’hôte se trouvent dans response.includes.users

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

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

// Récupérer un Space avec les informations de l’hôte
const response = await client.spaces.get("1DXxyRYNejbKM", {
  spaceFields: ["title", "host_ids", "state"],
  expansions: ["host_ids"],
  userFields: ["username", "verified"],
});

console.log(`Space: ${response.data?.title}`);
// Les informations de l’hôte se trouvent dans response.includes?.users

Réponse avec expansion

{
  "data": {
    "id": "1DXxyRYNejbKM",
    "state": "live",
    "title": "Discussing AI and the Future",
    "host_ids": ["2244994945"]
  },
  "includes": {
    "users": [
      {
        "id": "2244994945",
        "username": "XDevelopers",
        "verified": true
      }
    ]
  }
}

États des Spaces

État	Description
`live`	Actuellement en direct
`scheduled`	Planifié pour une date ultérieure
`ended`	A pris fin

Champs disponibles

Champ	Description
`title`	Titre du Space
`host_ids`	id des utilisateurs hôtes
`speaker_ids`	id des utilisateurs intervenants
`participant_count`	Nombre actuel de participants
`scheduled_start`	Heure de début planifiée
`started_at`	Heure de début effective
`ended_at`	Heure de fin effective
`is_ticketed`	Indique si le Space est payant (à tickets)
`state`	État actuel

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

Récupérer un Space par id

Réponse

Récupérer plusieurs Spaces

Récupérer des Spaces par créateur

Inclure les informations de l’hôte

Réponse avec expansion

États des Spaces

Champs disponibles

Prochaines étapes

Rechercher des Spaces

Référence de l’API