List your YouTube live broadcasts
youtube.x.youtube-livebroadcasts-listliveBroadcasts.list — Retrieve the list of broadcasts associated with the given channel.
- Price
- freeAt provider cost
- Success rate
- —No success-rate data yetNo success-rate data yet
- Latency p50
- ——
- Last verified
- —Not verified yet
GEThttps://toolswitch.dev/v1/tools/youtube.x.youtube-livebroadcasts-listPreview- Uses platform quota
- Synchronous response
- Reads public data
Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Query parameters | ||||
id | string | Optional | Return broadcasts with the given ids from Stubby or Apiary. | |
mine | boolean | Optional | ||
part | string | Required | The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics. | |
pageToken | string | Optional | The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. | |
maxResults | integer | Optional | The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. | |
broadcastType | string | Optional | Return only broadcasts with the selected type. | |
broadcastStatus | string | Optional | Return broadcasts with a certain status, e.g. active broadcasts. | |
onBehalfOfContentOwner | string | Optional | *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is inte | |
onBehalfOfContentOwnerChannel | string | Optional | This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required whe | |
- Query parameters
idstringOptionalReturn broadcasts with the given ids from Stubby or Apiary.
minebooleanOptionalpartstringRequiredThe *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.
pageTokenstringOptionalThe *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
maxResultsintegerOptionalThe *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
broadcastTypestringOptionalReturn only broadcasts with the selected type.
broadcastStatusstringOptionalReturn broadcasts with a certain status, e.g. active broadcasts.
onBehalfOfContentOwnerstringOptional*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is inte
onBehalfOfContentOwnerChannelstringOptionalThis parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required whe
Code samples
Replace $TOOLSWITCH_KEY with the key you created in the console.
curl -X GET 'https://toolswitch.dev/v1/tools/youtube.x.youtube-livebroadcasts-list' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY"import os
import requests
response = requests.request(
"GET",
"https://toolswitch.dev/v1/tools/youtube.x.youtube-livebroadcasts-list",
headers={"X-Toolswitch-Key": os.environ["TOOLSWITCH_KEY"]},
)
response.raise_for_status()
print(response.text)const response = await fetch("https://toolswitch.dev/v1/tools/youtube.x.youtube-livebroadcasts-list", {
method: "GET",
headers: {
"X-Toolswitch-Key": process.env.TOOLSWITCH_KEY ?? "",
},
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.text());This gateway API is in preview; its URL and authentication may change. The example parameters are sample data. Calls are billed at free, including the service fee.