Pré-requisitosAntes de começar, você precisará de:
- Uma conta de desenvolvedor com um App aprovado
- O Bearer Token do seu App
Obter um Space por ID
Recupere detalhes de um Space específico: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")
# Get a Space by 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"State: {response.data.state}")
print(f"Participants: {response.data.participant_count}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Get a Space by 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(`State: ${response.data?.state}`);
console.log(`Participants: ${response.data?.participant_count}`);
Resposta
{
"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"
}
}
Obter múltiplos Spaces
Consulte vários Spaces de uma vez: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")
# Get multiple 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" });
// Get multiple 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}`);
});
Obter Spaces por criador
Encontre Spaces hospedados por usuários específicos: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")
# Get Spaces by creator
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" });
// Get Spaces by creator
const response = await client.spaces.getByCreatorIds({
userIds: ["2244994945", "783214"],
spaceFields: ["title", "state", "scheduled_start"],
});
response.data?.forEach((space) => {
console.log(`${space.title} - ${space.state}`);
});
Incluir informações do host
Expanda os dados de usuário do host: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")
# Get Space with host info
response = client.spaces.get(
"1DXxyRYNejbKM",
space_fields=["title", "host_ids", "state"],
expansions=["host_ids"],
user_fields=["username", "verified"]
)
print(f"Space: {response.data.title}")
# Host info is in response.includes.users
import { Client } from "@xdevplatform/xdk";
const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });
// Get Space with host info
const response = await client.spaces.get("1DXxyRYNejbKM", {
spaceFields: ["title", "host_ids", "state"],
expansions: ["host_ids"],
userFields: ["username", "verified"],
});
console.log(`Space: ${response.data?.title}`);
// Host info is in response.includes?.users
Resposta com expansion
Exemplo de resposta{
"data": {
"id": "1DXxyRYNejbKM",
"state": "live",
"title": "Discussing AI and the Future",
"host_ids": ["2244994945"]
},
"includes": {
"users": [
{
"id": "2244994945",
"username": "XDevelopers",
"verified": true
}
]
}
}
Estados do Space
| Estado | Descrição |
|---|---|
live | Ativo no momento |
scheduled | Agendado para o futuro |
ended | Encerrado |
Campos disponíveis
| Campo | Descrição |
|---|---|
title | Título do Space |
host_ids | IDs de usuários host |
speaker_ids | IDs de usuários speaker |
participant_count | Participantes atuais |
scheduled_start | Horário de início agendado |
started_at | Horário de início real |
ended_at | Horário de término |
is_ticketed | Se o Space tem ingressos |
state | Estado atual |
Próximos passos
Buscar Spaces
Encontre Spaces por palavra-chave
Referência da API
Documentação completa dos endpoints