The YouTube Data API (v3) is an experimental API version, which means it is still in development. We'll be adding many more features to the API while it is still an experimental version. Until the experimental label is removed, however, the Deprecation Policy for YouTube APIs won't apply to this version as discussed in the API Terms of Service.
Returns a collection of zero or more channel
resources that match the request criteria.
Try it now.
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/channels
Parameters
Parameter name | Value | Description |
---|---|---|
Required parameters | ||
part |
string |
The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id , snippet , contentDetails , statistics , and topicDetails .If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails , the API response will also contain all of those nested properties. |
Filters (specify exactly one of the following parameters) | ||
id |
string |
The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID. |
mine |
boolean |
This parameter can only be used in a properly authorized request. Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user. |
categoryId |
string |
The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category. |
mySubscribers |
string |
This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel. |
Optional parameters | ||
maxResults |
unsigned integer |
The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50 , inclusive. The default value is 5 . |
pageToken |
string |
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. |
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "youtube#channelListResponse", "etag": etag, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "nextPageToken": string, "prevPageToken": string, "items": [ channels resource ] }
Properties
The following table defines the properties that appear in this resource:
Property name | Value | Description |
---|---|---|
kind |
string |
The type of the API response. For this operation, the value will be youtube#channelListResponse . |
etag |
etag |
The ETag for the response. |
pageInfo |
nested object |
The pageInfo object encapsulates paging information for the result set. |
pageInfo.totalResults |
integer |
The total number of results in the result set. |
pageInfo.resultsPerPage |
integer |
The number of results included in the API response. |
nextPageToken |
string |
The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
prevPageToken |
string |
The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. |
items[] |
list |
A list of channels that match the request criteria. |
Errors
The table below identifies error messages that the API could return in response to a call to this method.
Error name | Reason | Likely cause |
---|---|---|
notFound |
channelNotFound | The channel specified in the id parameter cannot be found. |
notFound |
categoryNotFound | The category identified by the categoryId parameter cannot be found. Use the guideCategories.list method to retrieve a list of valid values. |
forbidden |
channelForbidden | The channel specified in the id parameter does not support the request or the request is not properly authorized. |
Try it!
Use the API Explorer to call this method on live data and see the API request and response.