Skip to content
RelayXRelayX API

Get space detail

GET
/twitter/spaces/detail
const url = 'https://api.relayxapi.com/twitter/spaces/detail?space_id=example';
const options = {
  method: 'GET',
  headers: { 'X-API-Key': '<api-key>' },
};


try {
  const res = await fetch(url, options);
  const data = await res.json();
  console.log(data);
} catch (err) {
  console.error(err);
}

Return a Space’s details — title, host, speakers, state and listener counts.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
space_id
required
Space Id
string

Header Parameters

Section titled “Header Parameters”
x-api-key
X-Api-Key
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Example
{
  "status": "success",
  "msg": "",
  "data": {
    "data": {
      "audio_space_by_rest_id": {
        "is_subscribed": false,
        "metadata": {
          "conversation_controls": 0,
          "creator_results": {
            "rest_id": "1900000000000000001",
            "result": {
              "__typename": "User",
              "affiliates_highlighted_label": {},
              "avatar": {
                "image_url": "https://pbs.twimg.com/example.jpg"
              },
              "banner": {
                "image_url": "https://pbs.twimg.com/example.jpg"
              },
              "core": {
                "created_at_ms": 1677863168875,
                "name": "Example name",
                "screen_name": "example_user"
              },
              "dm_permissions": {
                "can_dm": true
              },
              "exclusive_tweet_following": false,
              "follow_request_sent": false,
              "has_graduated_access": true,
              "legacy": {
                "profile_interstitial_type": "",
                "want_retweets": false
              },
              "media_permissions": {
                "can_media_tag": false
              },
              "notifications_settings": {
                "notifications_enabled": false
              },
              "parody_commentary_fan_label": "None",
              "pinned_items": {
                "tweet_ids_str": [
                  "1900000000000000001"
                ]
              },
              "privacy": {
                "protected": false,
                "suspended": false
              },
              "private_super_following": false,
              "profile_bio": {
                "description": "Example description.",
                "entities": {
                  "description": {}
                }
              },
              "profile_image_shape": "Circle",
              "relationship_counts": {
                "followers": 197,
                "following": 198
              },
              "relationship_perspectives": {
                "blocked_by": false,
                "blocking": false,
                "followed_by": false,
                "following": false,
                "live_following": false,
                "muted_by": false,
                "muting": false
              },
              "reply_device_following_v2": false,
              "rest_id": "1900000000000000001",
              "smart_blocked_by": false,
              "smart_blocking": false,
              "super_follow_eligible": false,
              "super_followed_by": false,
              "super_following": false,
              "verification": {
                "is_blue_verified": false,
                "is_verified_organization": false,
                "is_verified_organization_affiliate": false,
                "verified": false
              }
            }
          },
          "creator_user_id": "ExampleId123",
          "disallow_join": false,
          "is_muted": false,
          "is_space_available_for_clipping": true,
          "is_space_available_for_replay": true,
          "max_admin_capacity": 3,
          "media_key": "ExampleId123",
          "narrow_cast_space_type": 0,
          "no_incognito": false,
          "participants": {
            "admins": [
              {
                "avatar_url": "https://pbs.twimg.com/example.jpg",
                "display_name": "Example text.",
                "is_muted_by_admin": false,
                "is_muted_by_guest": false,
                "twitter_screen_name": "example_user",
                "user_id": "ExampleId123",
                "user_results": {
                  "rest_id": "1900000000000000001",
                  "result": {
                    "__typename": "User",
                    "affiliates_highlighted_label": {},
                    "avatar": {
                      "image_url": "https://pbs.twimg.com/example.jpg"
                    },
                    "banner": {
                      "image_url": "https://pbs.twimg.com/example.jpg"
                    },
                    "core": {
                      "created_at_ms": 1677863168875,
                      "name": "Example name",
                      "screen_name": "example_user"
                    },
                    "dm_permissions": {
                      "can_dm": true
                    },
                    "exclusive_tweet_following": false,
                    "follow_request_sent": false,
                    "has_graduated_access": true,
                    "legacy": {
                      "profile_interstitial_type": "",
                      "want_retweets": false
                    },
                    "media_permissions": {
                      "can_media_tag": false
                    },
                    "notifications_settings": {
                      "notifications_enabled": false
                    },
                    "parody_commentary_fan_label": "None",
                    "pinned_items": {
                      "tweet_ids_str": [
                        "1900000000000000001"
                      ]
                    },
                    "privacy": {
                      "protected": false,
                      "suspended": false
                    },
                    "private_super_following": false,
                    "profile_bio": {
                      "description": "Example description.",
                      "entities": {
                        "description": {}
                      }
                    },
                    "profile_image_shape": "Circle",
                    "relationship_counts": {
                      "followers": 197,
                      "following": 198
                    },
                    "relationship_perspectives": {
                      "blocked_by": false,
                      "blocking": false,
                      "followed_by": false,
                      "following": false,
                      "live_following": false,
                      "muted_by": false,
                      "muting": false
                    },
                    "reply_device_following_v2": false,
                    "rest_id": "1900000000000000001",
                    "smart_blocked_by": false,
                    "smart_blocking": false,
                    "super_follow_eligible": false,
                    "super_followed_by": false,
                    "super_following": false,
                    "verification": {
                      "is_blue_verified": false,
                      "is_verified_organization": false,
                      "is_verified_organization_affiliate": false,
                      "verified": false
                    }
                  }
                }
              }
            ],
            "listeners": [],
            "poll_interval_sec": 7,
            "speakers": [],
            "total": 0
          },
          "primary_admin_user_id": "ExampleId123",
          "start": 1790344178368,
          "state": "Running",
          "total_live_listeners": 0,
          "total_participated": 0,
          "total_replay_watched": 0,
          "tweet_results": {
            "rest_id": "1900000000000000001"
          }
        }
      }
    }
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}