クイックスタート

このガイドでは、Spaces lookup エンドポイントを使用して Space に関する情報を取得する方法を説明します。

前提条件開始する前に、次のものが必要です。

承認済みの App を持つ開発者アカウント
App のベアラートークン

ID で Space を取得する

特定の Space の詳細を取得します:

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

# ID で Space を取得する
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" });

// ID で Space を取得する
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}`);

レスポンス

{
  "data": {
    "id": "1DXxyRYNejbKM",
    "state": "live",
    "title": "AIと未来について議論する",
    "host_ids": ["2244994945"],
    "participant_count": 245,
    "created_at": "2024-01-15T09:00:00.000Z"
  }
}

複数のSpaceを取得する

複数のSpaceをまとめて取得します。

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

# 複数のSpaceを取得する
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" });

// 複数のSpaceを取得する
const response = await client.spaces.getSpaces({
  ids: ["1DXxyRYNejbKM", "1YqJDqWYNQDGW"],
  spaceFields: ["title", "state", "participant_count"],
});

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

クリエイター ID で Spaces を取得する

特定のユーザーがホストしている Spaces を取得します。

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

# クリエイター ID で Spaces を取得
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" });

// クリエイター ID で Spaces を取得
const response = await client.spaces.getByCreatorIds({
  userIds: ["2244994945", "783214"],
  spaceFields: ["title", "state", "scheduled_start"],
});

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

ホスト情報を含める

ホストユーザーのデータを展開します:

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

# ホスト情報を含む Space を取得
response = client.spaces.get(
    "1DXxyRYNejbKM",
    space_fields=["title", "host_ids", "state"],
    expansions=["host_ids"],
    user_fields=["username", "verified"]
)

print(f"Space: {response.data.title}")
# ホスト情報は response.includes.users に含まれています

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

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

// ホスト情報を含む Space を取得
const response = await client.spaces.get("1DXxyRYNejbKM", {
  spaceFields: ["title", "host_ids", "state"],
  expansions: ["host_ids"],
  userFields: ["username", "verified"],
});

console.log(`Space: ${response.data?.title}`);
// ホスト情報は response.includes?.users に含まれています

拡張を含むレスポンス

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

Space の状態

State	説明
`live`	現在ライブ中
`scheduled`	開始予定
`ended`	終了済み

利用可能なフィールド

Field	Description
`title`	Space のタイトル
`host_ids`	ホストユーザーの ID
`speaker_ids`	スピーカーユーザーの ID
`participant_count`	現在の参加者数
`scheduled_start`	予定開始時刻
`started_at`	実際の開始時刻
`ended_at`	終了時刻
`is_ticketed`	Space がチケット制かどうか
`state`	現在の状態

概要

投稿

ユーザー

ダイレクトメッセージ

いいね

リスト

スペース

コミュニティ

コミュニティノート

トレンド

ニュース

メディア

X のアクティビティ

利用状況

ストリーム接続

コンプライアンス

Enterprise v2

いいねのストリーム

GNIP 2.0

クイックスタート

ID で Space を取得する

レスポンス

複数のSpaceを取得する

クリエイター ID で Spaces を取得する

ホスト情報を含める

拡張を含むレスポンス

Space の状態

利用可能なフィールド

次のステップ

Spaces を検索

APIリファレンス

​ID で Space を取得する

​レスポンス

​複数のSpaceを取得する

​クリエイター ID で Spaces を取得する

​ホスト情報を含める

​拡張を含むレスポンス

​Space の状態

​利用可能なフィールド

​次のステップ

Spaces を検索

APIリファレンス

ID で Space を取得する

レスポンス

複数のSpaceを取得する

クリエイター ID で Spaces を取得する

ホスト情報を含める

拡張を含むレスポンス

Space の状態

利用可能なフィールド

次のステップ