Videos: list

Returns a list of videos that match the API request parameters.
Try it now.

Quota impact: A call to this method has a quota cost of 1 unit in addition to the costs of the specified resource parts.

Usage

[This section requires a browser that supports JavaScript and iframes.]

Request

HTTP request

GET https://www.googleapis.com/youtube/v3/videos

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters

Required parameters

part

string
The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

The following list contains the part names that you can include in the parameter value and the quota cost for each part:

contentDetails: 2

fileDetails: 1

id: 0

liveStreamingDetails: 2

localizations: 2

player: 0

processingDetails: 1

recordingDetails: 2

snippet: 2

statistics: 2

status: 2

suggestions: 1

topicDetails: 2

Filters (specify exactly one of the following parameters)

chart

string
The chart parameter identifies the chart that you want to retrieve.

string
The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.

myRating

string
This parameter can only be used in a properly authorized request. Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

maxHeight

unsigned integer
The maxHeight parameter specifies the maximum height of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a height appropriate for your application layout. If the maxWidth parameter is also provided, the player may be shorter than the maxHeight in order to not violate the maximum width. Acceptable values are 72 to 8192, inclusive.

maxResults

unsigned integer
The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter. Acceptable values are 1 to 50, inclusive. The default value is 5.

maxWidth

unsigned integer
The maxWidth parameter specifies the maximum width of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a width appropriate for your application layout.

If the maxHeight parameter is also provided, the player may be narrower than maxWidth in order to not violate the maximum height. Acceptable values are 72 to 8192, inclusive.

onBehalfOfContentOwner

string
This parameter can only be used in a properly authorized request. 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 intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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.

Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter.

regionCode

string
The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.

videoCategoryId

string
The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category. The default value is 0.

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:

Properties

The following table defines the properties that appear in this resource:

Properties

kind

string
Identifies the API resource's type. The value will be youtube#videoListResponse.

etag

etag
The Etag of this resource.

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.

pageInfo

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.

items[]

list
A list of videos that match the request criteria.

Examples

Note: The following code samples may not represent all supported programming languages. See the client libraries documentation for a list of supported languages.

Java #1

This sample calls the API's search.list method with the type, q, location, and
locationRadius parameters to retrieve search results matching the provided keyword within the radius centered
at a particular location. Using the video IDs from the search result, the sample calls the API's videos.list
method to retrieve location details of each video.

PHP #1

This sample calls the API's search.list method with the type, q,
location and locationRadius parameters to retrieve search results matching the provided
keyword within the radius centered at a particular location. Using the video IDs from the search result, the sample
calls the API's videos.list method to retrieve location details of each video.

Python #1

This sample calls the API's search.list method with the type,
q, location, and locationRadius parameters to retrieve search results
matching the provided keyword within the radius centered at a particular location. Using the video ids from
the search result, the sample calls the API's videos.list method to retrieve location details
of each video.