Spaces を検索

指定された検索クエリに一致する Spaces の一覧を取得します。

GET /2/spaces/search

Spaces を検索

cURL

curl --request GET \
  --url https://api.x.com/2/spaces/search \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "1SLjjRYNejbKM",
      "state": "live",
      "created_at": "2021-07-06T18:40:40.000Z",
      "creator_id": "2244994945",
      "ended_at": "2021-07-06T18:40:40.000Z",
      "host_ids": [
        "2244994945"
      ],
      "invited_user_ids": [
        "2244994945"
      ],
      "is_ticketed": "false",
      "lang": "en",
      "participant_count": 10,
      "scheduled_start": "2021-07-06T18:40:40.000Z",
      "speaker_ids": [
        "2244994945"
      ],
      "started_at": "2021-7-14T04:35:55Z",
      "subscriber_count": 10,
      "title": "Spaces are Awesome",
      "topics": [
        {
          "description": "テクノロジー全般",
          "id": "848920371311001600",
          "name": "Technology"
        }
      ],
      "updated_at": "2021-7-14T04:35:55Z"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "includes": {
    "media": [
      {
        "type": "<string>",
        "preview_image_url": "<string>",
        "variants": [
          {
            "bit_rate": 123,
            "content_type": "<string>",
            "url": "<string>"
          }
        ],
        "height": 1,
        "media_key": "<string>",
        "width": 1
      }
    ],
    "places": [
      {
        "full_name": "Lakewood, CO",
        "id": "f7eb2fa2fea288b1",
        "contained_within": [
          "f7eb2fa2fea288b1"
        ],
        "country": "United States",
        "country_code": "US",
        "geo": {
          "bbox": [
            -105.193475,
            39.60973,
            -105.053164,
            39.761974
          ],
          "properties": {},
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -105.18816086351444,
              40.247749999999996
            ],
            "type": "Point"
          }
        },
        "name": "Lakewood",
        "place_type": "city"
      }
    ],
    "polls": [
      {
        "id": "1365059861688410112",
        "options": [
          {
            "label": "<string>",
            "position": 123,
            "votes": 123
          }
        ],
        "duration_minutes": 5042,
        "end_datetime": "2023-11-07T05:31:56Z"
      }
    ],
    "topics": [
      {
        "id": "<string>",
        "name": "Technology",
        "description": "All about technology"
      }
    ],
    "tweets": [
      {
        "author_id": "2244994945",
        "created_at": "Wed Jan 06 18:40:40 +0000 2021",
        "id": "1346889436626259968",
        "text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
        "username": "XDevelopers"
      }
    ],
    "users": [
      {
        "created_at": "2013-12-14T04:35:55Z",
        "id": "2244994945",
        "name": "X Dev",
        "protected": false,
        "username": "TwitterDev"
      }
    ]
  },
  "meta": {
    "result_count": 123
  }
}

承認

BearerTokenOAuth2UserToken

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

query · string · 必須

検索クエリ。

Required string length: 1 - 2048

例:

"crypto"

state · enum<string> · デフォルト: all

検索する Spaces の状態。

利用可能なオプション: live, scheduled, all

max_results · integer<int32> · デフォルト: 100

返却する結果数。

必須範囲: 1 <= x <= 100

space.fields · enum<string>[]

表示する Space のフィールドを指定するカンマ区切りのリストです。 Space オブジェクトで利用可能なフィールドです。

Minimum array length: 1

利用可能なオプション: created_at, creator_id, ended_at, host_ids, id, invited_user_ids, is_ticketed, lang, participant_count, scheduled_start, speaker_ids, started_at, state, subscriber_count, title, topic_ids, updated_at

例:

[
  "created_at",
  "creator_id",
  "ended_at",
  "host_ids",
  "id",
  "invited_user_ids",
  "is_ticketed",
  "lang",
  "participant_count",
  "scheduled_start",
  "speaker_ids",
  "started_at",
  "state",
  "subscriber_count",
  "title",
  "topic_ids",
  "updated_at"
]

expansions · enum<string>[]

展開するフィールドのカンマ区切りのリスト。 Space オブジェクトに対して展開可能なフィールドの一覧です。ID を持つフィールドは、完全なオブジェクトとして展開できます。

Minimum array length: 1

利用可能なオプション: creator_id, host_ids, invited_user_ids, speaker_ids, topic_ids

例:

[
  "creator_id",
  "host_ids",
  "invited_user_ids",
  "speaker_ids",
  "topic_ids"
]

user.fields · enum<string>[]

表示する User フィールドを指定するカンマ区切りのリストです。 User オブジェクトで利用可能なフィールドです。

Minimum array length: 1

利用可能なオプション: affiliation, confirmed_email, connection_status, created_at, description, entities, id, is_identity_verified, location, most_recent_tweet_id, name, parody, pinned_tweet_id, profile_banner_url, profile_image_url, protected, public_metrics, receives_your_dm, subscription, subscription_type, url, username, verified, verified_followers_count, verified_type, withheld

例:

[
  "affiliation",
  "confirmed_email",
  "connection_status",
  "created_at",
  "description",
  "entities",
  "id",
  "is_identity_verified",
  "location",
  "most_recent_tweet_id",
  "name",
  "parody",
  "pinned_tweet_id",
  "profile_banner_url",
  "profile_image_url",
  "protected",
  "public_metrics",
  "receives_your_dm",
  "subscription",
  "subscription_type",
  "url",
  "username",
  "verified",
  "verified_followers_count",
  "verified_type",
  "withheld"
]

topic.fields · enum<string>[]

表示する Topic のフィールドを指定するカンマ区切りのリストです。 Topic オブジェクトで利用可能なフィールドです。

Minimum array length: 1

利用可能なオプション: description, id, name

例:

["description", "id", "name"]

レスポンス

200

application/json

リクエストが成功しました。

data · object[]

Minimum array length: 1

Show child attributes

errors · object[]

Minimum array length: 1

IETF RFC 7807 (https://tools.ietf.org/html/rfc7807) で定義された HTTP Problem Details オブジェクト。

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Show child attributes

includes · object

Show child attributes

meta · object

Show child attributes