Videos: list

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

Request

HTTP request

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

Parameters

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

Parameter name	Value	Description
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. The `part` names that you can include in the parameter value are `id`, `snippet`, `contentDetails`, `fileDetails`, `player`, `processingDetails`, `recordingDetails`, `statistics`, `status`, `suggestions`, 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 `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.
Filters (specify exactly one of the following parameters)
`id`	`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. Acceptable values are: `dislike` – Returns only videos disliked by the authenticated user. `like` – Returns only video liked by the authenticated user.
Optional parameters
`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`.
`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.

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#videoListResponse",
  "etag": etag,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "nextPageToken": string,
  "prevPageToken": string,
  "items": [
    videos 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#videoListResponse`.
`etag`	`etag`	The ETag of 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 videos 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. Please see the error message documentation for more detail.

Error type	Error detail	Description
`forbidden`	`forbidden`	The request cannot access user rating information. This error may occur because the request is not properly authorized to use the `myRating` parameter.

Try it!

Use the API Explorer to call this method on live data and see the API request and response.

Last updated May 22, 2013.

YouTube