Google

YouTube Data API v3 (all endpoints)

The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.

Media & content#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.

Endpoints 83

abuseReports

  • POSTInserts a new resource into this collection./youtube/v3/abuseReports?part=stringInserts a new resource into this collection.

activities

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/activities?channelId=string&home=true&maxResults=0&mine=true&pageToken=string&part=string&publishedAfter=string&publishedBefore=string&regionCode=stringRetrieves a list of resources, possibly filtered.

captions

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/captions?id=string&onBehalfOf=string&onBehalfOfContentOwner=string&part=string&videoId=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/captions?onBehalfOf=string&onBehalfOfContentOwner=string&part=string&sync=trueUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/captions?onBehalfOf=string&onBehalfOfContentOwner=string&part=string&sync=trueInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/captions?id=string&onBehalfOf=string&onBehalfOfContentOwner=stringDeletes a resource.
  • GETDownloads a caption track./youtube/v3/captions/:id?onBehalfOf=string&onBehalfOfContentOwner=string&tfmt=string&tlang=stringDownloads a caption track.

channelBanners

  • POSTInserts a new resource into this collection./youtube/v3/channelBanners/insert?channelId=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=stringInserts a new resource into this collection.

channelSections

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/channelSections?channelId=string&hl=string&id=string&mine=true&onBehalfOfContentOwner=string&part=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/channelSections?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/channelSections?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/channelSections?id=string&onBehalfOfContentOwner=stringDeletes a resource.

channels

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/channels?categoryId=string&forHandle=string&forUsername=string&hl=string&id=string&managedByMe=true&maxResults=0&mine=true&mySubscribers=true&onBehalfOfContentOwner=string&pageToken=string&part=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/channels?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.

commentThreads

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/commentThreads?allThreadsRelatedToChannelId=string&channelId=string&id=string&maxResults=0&moderationStatus=published&order=orderUnspecified&pageToken=string&part=string&searchTerms=string&textFormat=textFormatUnspecified&videoId=stringRetrieves a list of resources, possibly filtered.
  • POSTInserts a new resource into this collection./youtube/v3/commentThreads?part=stringInserts a new resource into this collection.

comments

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/comments?id=string&maxResults=0&pageToken=string&parentId=string&part=string&textFormat=textFormatUnspecifiedRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/comments?part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/comments?part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/comments?id=stringDeletes a resource.
  • POSTExpresses the caller's opinion that one or more comments should be flagged as spam./youtube/v3/comments/markAsSpam?id=stringExpresses the caller's opinion that one or more comments should be flagged as spam.
  • POSTSets the moderation status of one or more comments./youtube/v3/comments/setModerationStatus?banAuthor=true&id=string&moderationStatus=publishedSets the moderation status of one or more comments.

i18nLanguages

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/i18nLanguages?hl=string&part=stringRetrieves a list of resources, possibly filtered.

i18nRegions

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/i18nRegions?hl=string&part=stringRetrieves a list of resources, possibly filtered.

liveBroadcasts

  • POSTBind a broadcast to a stream./youtube/v3/liveBroadcasts/bind?id=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=string&streamId=stringBind a broadcast to a stream.
  • GETRetrieve the list of broadcasts associated with the given channel./youtube/v3/liveBroadcasts?broadcastStatus=broadcastStatusFilterUnspecified&broadcastType=broadcastTypeFilterUnspecified&id=string&maxResults=0&mine=true&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&pageToken=string&part=stringRetrieve the list of broadcasts associated with the given channel.
  • PUTUpdates an existing broadcast for the authenticated user./youtube/v3/liveBroadcasts?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringUpdates an existing broadcast for the authenticated user.
  • POSTInserts a new stream for the authenticated user./youtube/v3/liveBroadcasts?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInserts a new stream for the authenticated user.
  • DELETEDelete a given broadcast./youtube/v3/liveBroadcasts?id=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=stringDelete a given broadcast.
  • POSTInsert cuepoints in a broadcast/youtube/v3/liveBroadcasts/cuepoint?id=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInsert cuepoints in a broadcast
  • POSTTransition a broadcast to a given status./youtube/v3/liveBroadcasts/transition?broadcastStatus=statusUnspecified&id=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringTransition a broadcast to a given status.

liveChatBans

  • POSTInserts a new resource into this collection./youtube/v3/liveChat/bans?part=stringInserts a new resource into this collection.
  • DELETEDeletes a chat ban./youtube/v3/liveChat/bans?id=stringDeletes a chat ban.

liveChatMessages

  • GETRetrieves a list of resources, possibly filtered/youtube/v3/liveChat/messages?hl=string&liveChatId=string&maxResults=0&pageToken=string&part=string&profileImageSize=0Retrieves a list of resources, possibly filtered. A call to this method has a quota cost of 5 units.
  • POSTInserts a new resource into this collection/youtube/v3/liveChat/messages?part=stringInserts a new resource into this collection. A call to this method has a quota cost of 20 units.
  • DELETEDeletes a chat message/youtube/v3/liveChat/messages?id=stringDeletes a chat message. A call to this method has a quota cost of 20 units.
  • POSTTransitions a durable chat event/youtube/v3/liveChat/messages/transition?id=string&status=statusUnspecifiedTransitions a durable chat event. A call to this method has a quota cost of 20 units.

liveChatModerators

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/liveChat/moderators?liveChatId=string&maxResults=0&pageToken=string&part=stringRetrieves a list of resources, possibly filtered.
  • POSTInserts a new resource into this collection./youtube/v3/liveChat/moderators?part=stringInserts a new resource into this collection.
  • DELETEDeletes a chat moderator./youtube/v3/liveChat/moderators?id=stringDeletes a chat moderator.

liveStreams

  • GETRetrieve the list of streams associated with the given channel/youtube/v3/liveStreams?id=string&maxResults=0&mine=true&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&pageToken=string&part=stringRetrieve the list of streams associated with the given channel. --
  • PUTUpdates an existing stream for the authenticated user./youtube/v3/liveStreams?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringUpdates an existing stream for the authenticated user.
  • POSTInserts a new stream for the authenticated user./youtube/v3/liveStreams?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInserts a new stream for the authenticated user.
  • DELETEDeletes an existing stream for the authenticated user./youtube/v3/liveStreams?id=string&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=stringDeletes an existing stream for the authenticated user.

members

  • GETRetrieves a list of members that match the request criteria for a channel./youtube/v3/members?filterByMemberChannelId=string&hasAccessToLevel=string&maxResults=0&mode=listMembersModeUnknown&pageToken=string&part=stringRetrieves a list of members that match the request criteria for a channel.

membershipsLevels

  • GETRetrieves a list of all pricing levels offered by a creator to the fans./youtube/v3/membershipsLevels?part=stringRetrieves a list of all pricing levels offered by a creator to the fans.

playlistImages

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/playlistImages?maxResults=0&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&pageToken=string&parent=string&part=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/playlistImages?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/playlistImages?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/playlistImages?id=string&onBehalfOfContentOwner=stringDeletes a resource.

playlistItems

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/playlistItems?id=string&maxResults=0&onBehalfOfContentOwner=string&pageToken=string&part=string&playlistId=string&videoId=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/playlistItems?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/playlistItems?onBehalfOfContentOwner=string&part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/playlistItems?id=string&onBehalfOfContentOwner=stringDeletes a resource.

playlists

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/playlists?channelId=string&hl=string&id=string&maxResults=0&mine=true&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&pageToken=string&part=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/playlists?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/playlists?onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/playlists?id=string&onBehalfOfContentOwner=stringDeletes a resource.

search

  • GETRetrieves a list of search resources/youtube/v3/search?channelId=string&channelType=channelTypeUnspecified&eventType=none&forContentOwner=true&forDeveloper=true&forMine=true&location=string&locationRadius=string&maxResults=0&onBehalfOfContentOwner=string&order=searchSortUnspecified&pageToken=string&part=string&publishedAfter=string&publishedBefore=string&q=string&regionCode=string&relevanceLanguage=string&safeSearch=safeSearchSettingUnspecified&topicId=string&type=string&videoCaption=videoCaptionUnspecified&videoCategoryId=string&videoDefinition=any&videoDimension=any&videoDuration=videoDurationUnspecified&videoEmbeddable=videoEmbeddableUnspecified&videoLicense=any&videoPaidProductPlacement=videoPaidProductPlacementUnspecified&videoSyndicated=videoSyndicatedUnspecified&videoType=videoTypeUnspecifiedRetrieves a list of search resources

subscriptions

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/subscriptions?channelId=string&forChannelId=string&id=string&maxResults=0&mine=true&myRecentSubscribers=true&mySubscribers=true&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&order=subscriptionOrderUnspecified&pageToken=string&part=stringRetrieves a list of resources, possibly filtered.
  • POSTInserts a new resource into this collection./youtube/v3/subscriptions?part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/subscriptions?id=stringDeletes a resource.

superChatEvents

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/superChatEvents?hl=string&maxResults=0&pageToken=string&part=stringRetrieves a list of resources, possibly filtered.

tests

  • POSTPOST method./youtube/v3/tests?externalChannelId=string&onBehalfOfContentOwnerChannel=string&part=stringPOST method.

thirdPartyLinks

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/thirdPartyLinks?externalChannelId=string&linkingToken=string&part=string&type=linkUnspecifiedRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/thirdPartyLinks?externalChannelId=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/thirdPartyLinks?externalChannelId=string&part=stringInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/thirdPartyLinks?externalChannelId=string&linkingToken=string&part=string&type=linkUnspecifiedDeletes a resource.

thumbnails

  • POSTAs this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which…/youtube/v3/thumbnails/set?onBehalfOfContentOwner=string&videoId=stringAs this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single…

videoAbuseReportReasons

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/videoAbuseReportReasons?hl=string&part=stringRetrieves a list of resources, possibly filtered.

videoCategories

  • GETRetrieves a list of resources, possibly filtered./youtube/v3/videoCategories?hl=string&id=string&part=string&regionCode=stringRetrieves a list of resources, possibly filtered.

videoTrainability

  • GETReturns the trainability status of a video./youtube/v3/videoTrainability?id=stringReturns the trainability status of a video.

videos

  • GETRetrieves a batch of VideoStat resources, possibly filtered/youtube/v3/videos:batchGetStats?id=string&onBehalfOfContentOwner=string&part=stringRetrieves a batch of VideoStat resources, possibly filtered. BatchGetStats is intentionally not atomic to provide a better user experience.
  • GETRetrieves a list of resources, possibly filtered./youtube/v3/videos?chart=chartUnspecified&hl=string&id=string&locale=string&maxHeight=0&maxResults=0&maxWidth=0&myRating=none&onBehalfOfContentOwner=string&pageToken=string&part=string&regionCode=string&videoCategoryId=stringRetrieves a list of resources, possibly filtered.
  • PUTUpdates an existing resource./youtube/v3/videos?onBehalfOfContentOwner=string&part=stringUpdates an existing resource.
  • POSTInserts a new resource into this collection./youtube/v3/videos?autoLevels=true&notifySubscribers=true&onBehalfOfContentOwner=string&onBehalfOfContentOwnerChannel=string&part=string&stabilize=trueInserts a new resource into this collection.
  • DELETEDeletes a resource./youtube/v3/videos?id=string&onBehalfOfContentOwner=stringDeletes a resource.
  • GETRetrieves the ratings that the authorized user gave to a list of specified videos./youtube/v3/videos/getRating?id=string&onBehalfOfContentOwner=stringRetrieves the ratings that the authorized user gave to a list of specified videos.
  • POSTAdds a like or dislike rating to a video or removes a rating from a video./youtube/v3/videos/rate?id=string&rating=noneAdds a like or dislike rating to a video or removes a rating from a video.
  • POSTReport abuse for a video./youtube/v3/videos/reportAbuse?onBehalfOfContentOwner=stringReport abuse for a video.

watermarks

  • POSTAllows upload of watermark image and setting it for a channel./youtube/v3/watermarks/set?channelId=string&onBehalfOfContentOwner=stringAllows upload of watermark image and setting it for a channel.
  • POSTAllows removal of channel watermark./youtube/v3/watermarks/unset?channelId=string&onBehalfOfContentOwner=stringAllows removal of channel watermark.

youtube.v3.liveChat.messages

  • GETAllows a user to load live chat through a server-streamed RPC/youtube/v3/liveChat/messages/stream?hl=string&liveChatId=string&maxResults=0&pageToken=string&part=string&profileImageSize=0Allows a user to load live chat through a server-streamed RPC. A call to this method has a quota cost of 5 units.

API details

Base URL
https://youtube.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 7 scopes
An API key in the key query parameter
Operations
83 operations on 44 pathsGET 29POST 29DELETE 14PUT 11
Main resources
videos 8liveBroadcasts 7comments 6captions 5channelSections 4liveChatMessages 4liveStreams 4playlistImages 4playlistItems 4playlists 4
Response formats
application/json
Description format
Google API Discovery, API version v3

How to test the YouTube Data API v3 (all endpoints) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the YouTube Data API v3 (all endpoints) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 7 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Inserts a new resource into this collection.” (POST /youtube/v3/abuseReports?part=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the YouTube Data API v3 (all endpoints)?

The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels. It is listed under Media & content and has 83 endpoints.

Who publishes the YouTube Data API v3 (all endpoints)?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the YouTube Data API v3 (all endpoints)?

Requests go to https://youtube.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the YouTube Data API v3 (all endpoints)?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 7 scopes; an API key in the key query parameter.

How many endpoints does the YouTube Data API v3 (all endpoints) have?

83 operations on 44 paths (29 GET, 29 POST, 14 DELETE, 11 PUT). The largest groups are videos, liveBroadcasts, comments, captions.

Is forking the YouTube Data API v3 (all endpoints) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.