The YouTube Data API lets you incorporate functions normally executed on the YouTube website into your own website or application. The lists below identify the different types of resources that you can retrieve using the API. The API also supports methods to insert, update, or delete many of these resources.
This reference guide explains how to use the API to perform all of these operations. The guide is organized by resource type. A resource represents a type of item that comprises part of the YouTube experience, such as a video, a playlist, or a subscription. For each resource type, the guide lists one or more data representations, and resources are represented as JSON objects. The guide also lists one or more supported methods ( LIST
, POST
, DELETE
, etc.) for each resource type and explains how to use those methods in your application.
Calling the API
The following requirements apply to YouTube Data API requests:
-
Every request must either specify an API key (with the
key
parameter) or provide an OAuth 2.0 token. Your API key is available in the Developer Console's API Accesspane for your project. -
You mustsend an authorization token for every insert, update, and delete request. You must also send an authorization token for any request that retrieves the authenticated user's private data.
In addition, some API methods for retrieving resources may support parameters that require authorization or may contain additional metadata when requests are authorized. For example, a request to retrieve a user's uploaded videos may also contain private videos if the request is authorized by that specific user.
-
The API supports the OAuth 2.0 authentication protocol. You can provide an OAuth 2.0 token in either of the following ways:
- Use the
access_token
query parameter like this:?access_token=
oauth2-token
- Use the HTTP
Authorization
header like this:Authorization: Bearer
oauth2-token
Complete instructions for implementing OAuth 2.0 authentication in your application can be found in the authentication guide .
- Use the
Resource types
Activities
An activity
resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, uploading a video, and so forth. Each activity
resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /activities
Captions
A caption
resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /captions/ id
tfmt
parameter and in its original language unless the request specifies a value for the tlang
parameter.GET /captions
captions.download
method provides the ability to retrieve a caption track.PUT /captions
ChannelBanners
A channelBanner
resource contains the URL that you would use to set a newly uploaded image as the banner image for a channel.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
POST /channelBanners/insert
- Call the
channelBanners.insert
method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2048x1152 pixels. We recommend uploading a 2560px by 1440px image. - Extract the
url
property's value from the response that the API returns for step 1. - Call the
channels.update
method to update the channel's branding settings. Set thebrandingSettings.image.bannerExternalUrl
property's value to the URL obtained in step 2.
ChannelSections
A channelSection
resource contains information about a set of videos that a channel has chosen to feature. For example, a section could feature a channel's latest uploads, most popular uploads, or videos from one or more playlists.
Note that a channel's sections are only visible if the channel displays content in a browse view (rather than a feed view). To enable a channel to display content in a browse view, set the brandingSettings.channel.showBrowseView
property to true
for the specified channel.
A channel can create a maximum of 10 shelves.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
POST /channelSections
GET /channelSections
channelSection
resources that match the API request criteria.Channels
A channel
resource contains information about a YouTube channel.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /channels
channel
resources that match the request criteria.PUT /channels
channel
resource's brandingSettings
and invideoPromotion
objects and their child properties.CommentThreads
A commentThread
resource contains information about a YouTube comment thread, which comprises a top-level comment and replies, if any exist, to that comment. A commentThread
resource can represent comments about either a video or a channel.
Both the top-level comment and the replies are actually comment
resources nested inside the commentThread
resource. The commentThread
resource does not necessarily contain all replies to a comment, and you need to use the comments.list
method if you want to retrieve all replies for a particular comment. Also note that some comments do not have replies.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
POST /commentThreads
comments.insert
method instead.GuideCategories
A guideCategory
resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories
, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /guideCategories
I18nLanguages
An i18nLanguage
resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language. For the YouTube website, an application language could be automatically selected based on Google Account settings, browser language, or IP location. A user could also manually select the desired UI language from the YouTube site footer.
Each i18nLanguage
resource identifies a language code and a name. The language code can be used as the value of the hl
parameter when calling API methods like videoCategories.list
and guideCategories.list
.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
I18nRegions
An i18nRegion
resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale. For the YouTube website, a content region could be automatically selected based on heuristics like the YouTube domain or the user's IP location. A user could also manually select the desired content region from the YouTube site footer.
Each i18nRegion
resource identifies a region code and a name. The region code can be used as the value of the regionCode
parameter when calling API methods like search.list
, videos.list
, activities.list
, and videoCategories.list
.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
Members
A member
resource represents a channel member for a YouTube
channel. A member provides recurring monetary support to a creator and receives special
benefits. For example, members are able to chat when the creator turns on members-only mode for
a chat.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /members
MembershipsLevels
A membershipsLevel
resource identifies a pricing level for the
creator that authorized the API request.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /membershipsLevels
membershipsLevel
resources owned by the channel that authorized the API request. Levels are returned in
implicit display order.PlaylistItems
A playlistItem
resource identifies another resource, such as a
video, that is included in a playlist. In addition, the playlistItem
resource
contains details about the included resource that pertain specifically to how that resource
is used in that playlist.
YouTube also uses a playlist to identify a channel's list of uploaded videos, with each playlistItem
in that list representing one uploaded video. You can retrieve the
playlist ID for that list from the channel resource
for a given channel. You can then use the playlistItems.list
method to the
list.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /playlistItems
PUT /playlistItems
Playlists
A playlist
resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. By default, playlists are publicly visible to other users, but playlists can be public or private.
YouTube also uses playlists to identify special collections of videos for a channel, such as:
- uploaded videos
- positively rated (liked) videos
- watch history
- watch later
channel resource
for a given channel.You can then use the
playlistItems.list
method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert
and playlistItems.delete
methods. For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /playlists
PUT /playlists
Search
A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
Subscriptions
A subscription
resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.
For more information about this resource, see its resource representation and list of properties .
Thumbnails
A thumbnail
resource identifies different thumbnail image sizes associated with a resource. Please note the following characteristics of thumbnail images:
- A resource's
snippet.thumbnails
property is an object that identifies the thumbnail images available for that resource. - A
thumbnail
resource contains a series of objects. The name of each object (default
,medium
,high
, etc.) refers to the thumbnail image size. - Different types of resources may support different thumbnail image sizes.
- Different types of resources may define different sizes for thumbnail images with the same name. For example, the
default
thumbnail image for avideo
resource is typically 120px by 90px, and thedefault
thumbnail image for achannel
resource is typically 88px by 88px. - Resources of the same type may still have different thumbnail image sizes for certain images depending on the resolution of the original image or content uploaded to YouTube. For example, an HD video may support higher resolution thumbnails than non-HD videos.
- Each object that contains information about a thumbnail image size has a
width
property and aheight
property. However, the width and height properties may not be returned for that image. - If an uploaded thumbnail image does not match the required dimensions, the image is resized to match the correct size without changing its aspect ratio. The image is not cropped, but may include black bars so that the size is correct.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
VideoAbuseReportReasons
A videoAbuseReportReason
resource contains information about a reason that a video would be flagged for containing abusive content. When your application calls the videos.reportAbuse
method to report an abusive video, the request uses the information from a videoAbuseReportReason
resource to identify the reason that the video is being reported.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /videoAbuseReportReasons
VideoCategories
A videoCategory
resource identifies a category that has been or could be associated with uploaded videos.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
Videos
A video
resource represents a YouTube video.
For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
GET /videos/getRating
Watermarks
A watermark
resource identifies an image that displays during playbacks of a specified channel's videos. You can also specify a target channel to which the image will link as well as timing details that determine when the watermark appears during video playbacks and the length of time it is visible.
For more information about this resource, see its resource representation and list of properties .
Comments
A
comment
resource contains information about a single YouTube comment. Acomment
resource can represent a comment about either a video or a channel. In addition, the comment could be a top-level comment or a reply to a top-level comment.For more information about this resource, see its resource representation and list of properties .
https://www.googleapis.com/youtube/v3
list
GET /comments
setModerationStatus
POST /comments/setModerationStatus
insert
POST /comments
commentThreads.insert
method.markAsSpam
POST /comments/markAsSpam
delete
DELETE /comments
update
PUT /comments