iv-org/documentation
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/documentation synced 2025-03-30 23:10:11 +02:00
Code Issues Packages Projects Releases Wiki Activity
documentation/site/API/index.html
TheFrenchGhosty a1902ff41d
Move to mkdocs-material (#207)
2022-03-08 14:33:39 +00:00

1765 lines
45 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The official Invidious documentation">
<meta name="author" content="The Invidious project.">
<link rel="canonical" href="https://docs.invidious.io/API/">
<link rel="icon" href="../images/favicon.ico">
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.5">
<title>API - Invidious Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.2d9f7617.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
<meta name="theme-color" content="#000000">
<script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="black" data-md-color-accent="">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#language" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Invidious Documentation" class="md-header__button md-logo" aria-label="Invidious Documentation" data-md-component="logo">
<img src="../images/invidious.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Invidious Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
API
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Invidious Documentation" class="md-nav__button md-logo" aria-label="Invidious Documentation" data-md-component="logo">
<img src="../images/invidious.png" alt="logo">
</a>
Invidious Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
HOME
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
API
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
API
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#language" class="md-nav__link">
Language
</a>
</li>
<li class="md-nav__item">
<a href="#pretty" class="md-nav__link">
Pretty
</a>
</li>
<li class="md-nav__item">
<a href="#fields" class="md-nav__link">
Fields
</a>
<nav class="md-nav" aria-label="Fields">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-apiv1stats" class="md-nav__link">
GET /api/v1/stats
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1videosid" class="md-nav__link">
GET /api/v1/videos/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1annotationsid" class="md-nav__link">
GET /api/v1/annotations/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1commentsid" class="md-nav__link">
GET /api/v1/comments/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1captionsid" class="md-nav__link">
GET /api/v1/captions/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1trending" class="md-nav__link">
GET /api/v1/trending
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1popular" class="md-nav__link">
GET /api/v1/popular
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucid" class="md-nav__link">
GET /api/v1/channels/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucidvideos-apiv1channelsvideosucid" class="md-nav__link">
GET /api/v1/channels/:ucid/videos, /api/v1/channels/videos/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucidlatest-apiv1channelslatestucid" class="md-nav__link">
GET /api/v1/channels/:ucid/latest, /api/v1/channels/latest/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsplaylistsucid-apiv1channelsucidplaylists" class="md-nav__link">
GET /api/v1/channels/playlists/:ucid, /api/v1/channels/:ucid/playlists
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelscommentsucid-apiv1channelsucidcomments" class="md-nav__link">
GET /api/v1/channels/comments/:ucid, /api/v1/channels/:ucid/comments
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelssearchucid" class="md-nav__link">
GET /api/v1/channels/search/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1searchsuggestions" class="md-nav__link">
GET /api/v1/search/suggestions
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1search" class="md-nav__link">
GET /api/v1/search
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1playlistsplid" class="md-nav__link">
GET /api/v1/playlists/:plid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1mixesrdid" class="md-nav__link">
GET /api/v1/mixes/:rdid
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../Always-use-%22local%22-to-proxy-video-through-the-server-without-creating-an-account/" class="md-nav__link">
Always-use-"local"-to-proxy-video-through-the-server-without-creating-an-account
</a>
</li>
<li class="md-nav__item">
<a href="../Apache2-Reverse-Proxy/" class="md-nav__link">
Apache2-Reverse-Proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Apache2-reverse-proxy/" class="md-nav__link">
Apache2-reverse-proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Authenticated-Endpoints/" class="md-nav__link">
Authenticated-Endpoints
</a>
</li>
<li class="md-nav__item">
<a href="../Configuration/" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="../Database-Information-and-Maintenance/" class="md-nav__link">
Database-Information-and-Maintenance
</a>
</li>
<li class="md-nav__item">
<a href="../Export-YouTube-subscriptions/" class="md-nav__link">
Export-YouTube-subscriptions
</a>
</li>
<li class="md-nav__item">
<a href="../Extensions/" class="md-nav__link">
Extensions
</a>
</li>
<li class="md-nav__item">
<a href="../FAQ/" class="md-nav__link">
Frequently Asked Questions
</a>
</li>
<li class="md-nav__item">
<a href="../Geoblocking%2C-available-video-quality-and-DASH/" class="md-nav__link">
Geoblocking,-available-video-quality-and-DASH
</a>
</li>
<li class="md-nav__item">
<a href="../How-to-deal-with-uMatrix/" class="md-nav__link">
How-to-deal-with-uMatrix
</a>
</li>
<li class="md-nav__item">
<a href="../How-to-setup-Anti-Captcha/" class="md-nav__link">
How-to-setup-Anti-Captcha
</a>
</li>
<li class="md-nav__item">
<a href="../Installation/" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="../Invidious-Instances/" class="md-nav__link">
Invidious-Instances
</a>
</li>
<li class="md-nav__item">
<a href="../Issues-with-CAPTCHA-on-Debian-and-Ubuntu/" class="md-nav__link">
Issues-with-CAPTCHA-on-Debian-and-Ubuntu
</a>
</li>
<li class="md-nav__item">
<a href="../Known-Exception-in-log/" class="md-nav__link">
Known-Exception-in-log
</a>
</li>
<li class="md-nav__item">
<a href="../List-of-URL-parameters/" class="md-nav__link">
List-of-URL-parameters
</a>
</li>
<li class="md-nav__item">
<a href="../NGINX-Reverse-Proxy/" class="md-nav__link">
NGINX-Reverse-Proxy
</a>
</li>
<li class="md-nav__item">
<a href="../Preferences/" class="md-nav__link">
Preferences
</a>
</li>
<li class="md-nav__item">
<a href="../Search-operators/" class="md-nav__link">
Search-operators
</a>
</li>
<li class="md-nav__item">
<a href="../Takedowns/" class="md-nav__link">
DMCA
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#language" class="md-nav__link">
Language
</a>
</li>
<li class="md-nav__item">
<a href="#pretty" class="md-nav__link">
Pretty
</a>
</li>
<li class="md-nav__item">
<a href="#fields" class="md-nav__link">
Fields
</a>
<nav class="md-nav" aria-label="Fields">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#get-apiv1stats" class="md-nav__link">
GET /api/v1/stats
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1videosid" class="md-nav__link">
GET /api/v1/videos/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1annotationsid" class="md-nav__link">
GET /api/v1/annotations/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1commentsid" class="md-nav__link">
GET /api/v1/comments/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1captionsid" class="md-nav__link">
GET /api/v1/captions/:id
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1trending" class="md-nav__link">
GET /api/v1/trending
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1popular" class="md-nav__link">
GET /api/v1/popular
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucid" class="md-nav__link">
GET /api/v1/channels/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucidvideos-apiv1channelsvideosucid" class="md-nav__link">
GET /api/v1/channels/:ucid/videos, /api/v1/channels/videos/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsucidlatest-apiv1channelslatestucid" class="md-nav__link">
GET /api/v1/channels/:ucid/latest, /api/v1/channels/latest/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelsplaylistsucid-apiv1channelsucidplaylists" class="md-nav__link">
GET /api/v1/channels/playlists/:ucid, /api/v1/channels/:ucid/playlists
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelscommentsucid-apiv1channelsucidcomments" class="md-nav__link">
GET /api/v1/channels/comments/:ucid, /api/v1/channels/:ucid/comments
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1channelssearchucid" class="md-nav__link">
GET /api/v1/channels/search/:ucid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1searchsuggestions" class="md-nav__link">
GET /api/v1/search/suggestions
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1search" class="md-nav__link">
GET /api/v1/search
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1playlistsplid" class="md-nav__link">
GET /api/v1/playlists/:plid
</a>
</li>
<li class="md-nav__item">
<a href="#get-apiv1mixesrdid" class="md-nav__link">
GET /api/v1/mixes/:rdid
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>API</h1>
<h3 id="language">Language</h3>
<p>All endpoints that return a JSON body support <code>&amp;hl=LANGUAGE</code> for translating fields into the desired language. A list of languages are provided in <a href="./List-of-URL-parameters">List of URL parameters</a>.</p>
<h3 id="pretty">Pretty</h3>
<p>All endpoints that return a JSON body support <code>&amp;pretty=1</code> for printing the response as formatted JSON.</p>
<h3 id="fields">Fields</h3>
<p>All endpoints that return a JSON body support the <a href="https://developers.google.com/youtube/v3/getting-started#fields">fields API</a> for specifying desired fields to reduce bandwidth consumption. This can be used by adding <code>&amp;fields=FIELDS</code> with the desired fields, for example <a href="https://invidio.us/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&amp;pretty=1"><code>/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&amp;pretty=1</code></a>.</p>
<h5 id="get-apiv1stats">GET <code>/api/v1/stats</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;version&quot;: String,
&quot;software&quot;: {
&quot;name&quot;: &quot;invidious&quot;,
&quot;version&quot;: String,
&quot;branch&quot;: String
},
&quot;openRegistrations&quot;: Bool,
&quot;usage&quot;: {
&quot;users&quot;: {
&quot;total&quot;: Int32,
&quot;activeHalfyear&quot;: Int32,
&quot;activeMonth&quot;: Int32
}
},
&quot;metadata&quot;: {
&quot;updatedAt&quot;: Int64,
&quot;lastChannelRefreshedAt&quot;: Int64
}
}
</code></pre>
<h5 id="get-apiv1videosid">GET <code>/api/v1/videos/:id</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;description&quot;: String,
&quot;descriptionHtml&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;keywords&quot;: Array(String),
&quot;viewCount&quot;: Int64,
&quot;likeCount&quot;: Int32,
&quot;dislikeCount&quot;: Int32,
&quot;paid&quot;: Bool,
&quot;premium&quot;: Bool,
&quot;isFamilyFriendly&quot;: Bool,
&quot;allowedRegions&quot;: Array(String),
&quot;genre&quot;: String,
&quot;genreUrl&quot;: String,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;authorThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;subCountText&quot;: String,
&quot;lengthSeconds&quot;: Int32,
&quot;allowRatings&quot;: Bool,
&quot;rating&quot;: Float32,
&quot;isListed&quot;: Bool,
&quot;liveNow&quot;: Bool,
&quot;isUpcoming&quot;: Bool,
&quot;premiereTimestamp&quot;: Int64?,
&quot;hlsUrl&quot;: String?,
&quot;adaptiveFormats&quot;: [
{
&quot;index&quot;: String,
&quot;bitrate&quot;: String,
&quot;init&quot;: String,
&quot;url&quot;: String,
&quot;itag&quot;: String,
&quot;type&quot;: String,
&quot;clen&quot;: String,
&quot;lmt&quot;: String,
&quot;projectionType&quot;: Int32,
&quot;container&quot;: String,
&quot;encoding&quot;: String,
&quot;qualityLabel&quot;: String?,
&quot;resolution&quot;: String?
}
],
&quot;formatStreams&quot;: [
{
&quot;url&quot;: String,
&quot;itag&quot;: String,
&quot;type&quot;: String,
&quot;quality&quot;: String,
&quot;container&quot;: String,
&quot;encoding&quot;: String,
&quot;qualityLabel&quot;: String,
&quot;resolution&quot;: String,
&quot;size&quot;: String
}
],
&quot;captions&quot;: [
{
&quot;label&quot;: String,
&quot;languageCode&quot;: String,
&quot;url&quot;: String
}
],
&quot;recommendedVideos&quot;: [
{
&quot;videoId&quot;: String,
&quot;title&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;author&quot;: String,
&quot;lengthSeconds&quot;: Int32,
&quot;viewCountText&quot;: String
}
]
}
</code></pre>
<p>Parameters:</p>
<pre><code>region: ISO 3166 country code (default: &quot;US&quot;)
</code></pre>
<h5 id="get-apiv1annotationsid">GET <code>/api/v1/annotations/:id</code></h5>
<p>Parameters:</p>
<pre><code>source: &quot;archive&quot;, &quot;youtube&quot; (default: &quot;archive&quot;)
</code></pre>
<p>Returns annotation XML from YouTube's <code>/annotations_invideo</code> endpoint. Alternatively it provides access to legacy annotation data using <a href="https://archive.org/details/youtubeannotations">this collection</a> on archive.org.</p>
<h5 id="get-apiv1commentsid">GET <code>/api/v1/comments/:id</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;commentCount&quot;: Int32?,
&quot;videoId&quot;: String,
&quot;comments&quot;: [
{
&quot;author&quot;: String,
&quot;authorThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;isEdited&quot;: Bool,
&quot;content&quot;: String,
&quot;contentHtml&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;likeCount&quot;: Int32,
&quot;commentId&quot;: String,
&quot;authorIsChannelOwner&quot;: Bool,
&quot;creatorHeart&quot;: {
&quot;creatorThumbnail&quot;: String,
&quot;creatorName&quot;: String
}?,
&quot;replies&quot;: {
&quot;replyCount&quot;: Int32,
&quot;continuation&quot;: String
}?
}
],
&quot;continuation&quot;: String?
}
</code></pre>
<p>Parameters:</p>
<pre><code>sort_by: &quot;top&quot;, &quot;new&quot; (default: top)
source: &quot;youtube&quot;, &quot;reddit&quot; (default: youtube)
continuation: String
</code></pre>
<h5 id="get-apiv1captionsid">GET <code>/api/v1/captions/:id</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;captions&quot;: [
{
&quot;label&quot;: String,
&quot;languageCode&quot;: String,
&quot;url&quot;: String
}
]
}
</code></pre>
<p>Parameters:</p>
<pre><code>label: String
lang: String
tlang: String
region: ISO 3166 country code (default: &quot;US&quot;)
</code></pre>
<p>A request with <code>label</code> will return the selected captions in WebVTT format.
Captions can also be selected with an ISO <code>lang</code>, e.g. &amp;lang=en, <code>tlang</code> will auto-translate from English into the requested language (if English captions are available).</p>
<h5 id="get-apiv1trending">GET <code>/api/v1/trending</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">[
{
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;lengthSeconds&quot;: Int32,
&quot;viewCount&quot;: Int64,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;description&quot;: String,
&quot;descriptionHtml&quot;: String,
&quot;liveNow&quot;: Bool,
&quot;paid&quot;: Bool,
&quot;premium&quot;: Bool
}
]
</code></pre>
<p>Parameters:</p>
<pre><code>type: &quot;music&quot;, &quot;gaming&quot;, &quot;news&quot;, &quot;movies&quot;
region: ISO 3166 country code (default: &quot;US&quot;)
</code></pre>
<h5 id="get-apiv1popular">GET <code>/api/v1/popular</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">[
{
&quot;type&quot;: &quot;shortVideo&quot;,
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;lengthSeconds&quot;: Int32,
&quot;viewCount&quot;: Int64,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String
}
]
</code></pre>
<h5 id="get-apiv1channelsucid">GET <code>/api/v1/channels/:ucid</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;authorBanners&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;authorThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;subCount&quot;: Int32,
&quot;totalViews&quot;: Int64,
&quot;joined&quot;: Int64,
&quot;paid&quot;: Bool,
&quot;autoGenerated&quot;: Bool,
&quot;isFamilyFriendly&quot;: Bool,
&quot;description&quot;: String,
&quot;descriptionHtml&quot;: String,
&quot;allowedRegions&quot;: Array(String),
&quot;latestVideos&quot;: [
{
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;description&quot;: String,
&quot;descriptionHtml&quot;: String,
&quot;viewCount&quot;: Int64,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;lengthSeconds&quot;: Int32,
&quot;paid&quot;: Bool,
&quot;premium&quot;: Bool
}
],
&quot;relatedChannels&quot;: [
{
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;authorThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
]
}
]
}
</code></pre>
<p>Parameters:</p>
<pre><code>sort_by: &quot;newest&quot;, &quot;oldest&quot;, &quot;popular&quot; (default: newest)
</code></pre>
<p>Note that a channel's username (if it doesn't include spaces) is also valid in place of <code>ucid</code>, e.g. <code>/api/v1/channels/BlenderFoundation</code>.</p>
<h5 id="get-apiv1channelsucidvideos-apiv1channelsvideosucid">GET <code>/api/v1/channels/:ucid/videos</code>, <code>/api/v1/channels/videos/:ucid</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">[
{
title: String,
videoId: String,
author: String,
authorId: String,
authorUrl: String,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
],
description: String,
descriptionHtml: String,
viewCount: Int64,
published: Int64,
publishedText: String,
lengthSeconds: Int32
paid: Bool,
premium: Bool
}
]
</code></pre>
<p>Parameters:</p>
<pre><code>page: Int32
sort_by: &quot;newest&quot;, &quot;oldest&quot;, &quot;popular&quot; (default: newest)
</code></pre>
<h5 id="get-apiv1channelsucidlatest-apiv1channelslatestucid">GET <code>/api/v1/channels/:ucid/latest</code>, <code>/api/v1/channels/latest/:ucid</code></h5>
<pre><code class="language-javascript">[
{
title: String,
videoId: String,
authorId: String,
authorUrl: String,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
],
description: String,
descriptionHtml: String,
viewCount: Int64,
published: Int64,
publishedText: String,
lengthSeconds: Int32
paid: Bool,
premium: Bool
}
]
</code></pre>
<h5 id="get-apiv1channelsplaylistsucid-apiv1channelsucidplaylists">GET <code>/api/v1/channels/playlists/:ucid</code>, <code>/api/v1/channels/:ucid/playlists</code></h5>
<pre><code class="language-javascript">{
&quot;playlists&quot;: [
{
&quot;title&quot;: String,
&quot;playlistId&quot;: String,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;videoCount&quot;: Int32,
&quot;videos&quot;: [
{
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;lengthSeconds&quot;: Int32,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
]
}
]
],
&quot;continuation&quot;: String?
}
</code></pre>
<p>Parameters:</p>
<pre><code>continuation: String
sort_by: &quot;oldest&quot;, &quot;newest&quot;, &quot;last&quot;
</code></pre>
<h5 id="get-apiv1channelscommentsucid-apiv1channelsucidcomments">GET <code>/api/v1/channels/comments/:ucid</code>, <code>/api/v1/channels/:ucid/comments</code></h5>
<pre><code class="language-javascript">{
&quot;authorId&quot;: String,
&quot;comments&quot;: [
{
&quot;author&quot;: String,
&quot;authorThumbnails&quot;: [
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
],
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;isEdited&quot;: Bool,
&quot;content&quot;: String,
&quot;contentHtml&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;likeCount&quot;: Int32,
&quot;commentId&quot;: String,
&quot;authorIsChannelOwner&quot;: Bool,
&quot;creatorHeart&quot;: {
&quot;creatorThumbnail&quot;: String,
&quot;creatorName&quot;: String
}?,
&quot;replies&quot;: {
&quot;replyCount&quot;: Int32,
&quot;continuation&quot;: String
}?,
&quot;attachment&quot;: Attachment?
}
],
&quot;continuation&quot;: String?
}
</code></pre>
<p>The <code>authorId</code> for top-level comments will always(?) be the same as the requested channel. Top-level comments will also have an optional <code>attachment</code>, which can be one of:</p>
<pre><code class="language-javascript">{
&quot;type&quot;: &quot;image&quot;,
&quot;imageThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
]
}
</code></pre>
<pre><code class="language-javascript">{
&quot;type&quot;: &quot;video&quot;,
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;lengthSeconds&quot;: Int32,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;published&quot;: Int64,
&quot;publishedText&quot;: String,
&quot;viewCount&quot;: Int64,
&quot;viewCountText&quot;: String
}
</code></pre>
<pre><code class="language-javascript">{
&quot;type&quot;: &quot;unknown&quot;,
&quot;error&quot;: &quot;Unrecognized attachment type.&quot;
}
</code></pre>
<p>Some attachments may only have a <code>type</code> and <code>error</code>, similar to the above. Attachments will <em>only</em> be present on top-level comments.</p>
<p>Parameters:</p>
<pre><code>continuation: String
</code></pre>
<h5 id="get-apiv1channelssearchucid">GET <code>/api/v1/channels/search/:ucid</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">[
{
type: &quot;video&quot;,
title: String,
videoId: String,
author: String,
authorId: String,
authorUrl: String,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
],
description: String,
descriptionHtml: String,
viewCount: Int64,
published: Int64,
publishedText: String,
lengthSeconds: Int32,
liveNow: Bool,
paid: Bool,
premium: Bool
},
{
type: &quot;playlist&quot;,
title: String,
playlistId: String,
author: String,
authorId: String,
authorUrl: String,
videoCount: Int32,
videos: [
{
title: String,
videoId: String,
lengthSeconds: Int32,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
]
}
]
},
{
type: &quot;channel&quot;,
author: String,
authorId: String,
authorUrl: String,
authorThumbnails: [
{
url: String,
width: Int32,
height: Int32
}
],
subCount: Int32,
videoCount: Int32,
description: String,
descriptionHtml: String
}
];
</code></pre>
<p>Parameters:</p>
<pre><code>q: String
page: Int32
</code></pre>
<h5 id="get-apiv1searchsuggestions">GET <code>/api/v1/search/suggestions</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;query&quot;: String,
&quot;suggestions&quot;: Array(String)
}
</code></pre>
<p>Parameters:</p>
<pre><code>q: String
</code></pre>
<h5 id="get-apiv1search">GET <code>/api/v1/search</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">[
{
type: &quot;video&quot;,
title: String,
videoId: String,
author: String,
authorId: String,
authorUrl: String,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
],
description: String,
descriptionHtml: String,
viewCount: Int64,
published: Int64,
publishedText: String,
lengthSeconds: Int32,
liveNow: Bool,
paid: Bool,
premium: Bool
},
{
type: &quot;playlist&quot;,
title: String,
playlistId: String,
author: String,
authorId: String,
authorUrl: String,
videoCount: Int32,
videos: [
{
title: String,
videoId: String,
lengthSeconds: Int32,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
]
}
]
},
{
type: &quot;channel&quot;,
author: String,
authorId: String,
authorUrl: String,
authorThumbnails: [
{
url: String,
width: Int32,
height: Int32
}
],
subCount: Int32,
videoCount: Int32,
description: String,
descriptionHtml: String
}
];
</code></pre>
<p>Parameters:</p>
<pre><code>q: String
page: Int32
sort_by: &quot;relevance&quot;, &quot;rating&quot;, &quot;upload_date&quot;, &quot;view_count&quot;
date: &quot;hour&quot;, &quot;today&quot;, &quot;week&quot;, &quot;month&quot;, &quot;year&quot;
duration: &quot;short&quot;, &quot;long&quot;
type: &quot;video&quot;, &quot;playlist&quot;, &quot;channel&quot;, &quot;all&quot;, (default: video)
features: &quot;hd&quot;, &quot;subtitles&quot;, &quot;creative_commons&quot;, &quot;3d&quot;, &quot;live&quot;, &quot;purchased&quot;, &quot;4k&quot;, &quot;360&quot;, &quot;location&quot;, &quot;hdr&quot; (comma separated: e.g. &quot;&amp;features=hd,subtitles,3d,live&quot;)
region: ISO 3166 country code (default: &quot;US&quot;)
</code></pre>
<h5 id="get-apiv1playlistsplid">GET <code>/api/v1/playlists/:plid</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
&quot;title&quot;: String,
&quot;playlistId&quot;: String,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorThumbnails&quot;: [
{
&quot;url&quot;: String,
&quot;width&quot;: String,
&quot;height&quot;: String
}
],
&quot;description&quot;: String,
&quot;descriptionHtml&quot;: String,
&quot;videoCount&quot;: Int32,
&quot;viewCount&quot;: Int64,
&quot;updated&quot;: Int64,
&quot;videos&quot;: [
{
&quot;title&quot;: String,
&quot;videoId&quot;: String,
&quot;author&quot;: String,
&quot;authorId&quot;: String,
&quot;authorUrl&quot;: String,
&quot;videoThumbnails&quot;: [
{
&quot;quality&quot;: String,
&quot;url&quot;: String,
&quot;width&quot;: Int32,
&quot;height&quot;: Int32
}
],
&quot;index&quot;: Int32,
&quot;lengthSeconds&quot;: Int32
}
]
}
</code></pre>
<p>Parameters:</p>
<pre><code>page: Int32
</code></pre>
<h5 id="get-apiv1mixesrdid">GET <code>/api/v1/mixes/:rdid</code></h5>
<blockquote>
<p>Schema:</p>
</blockquote>
<pre><code class="language-javascript">{
title: String,
mixId: String,
videos: [
{
title: String,
videoId: String,
author: String,
authorId: String,
authorUrl: String,
videoThumbnails: [
{
quality: String,
url: String,
width: Int32,
height: Int32
}
],
index: Int32,
lengthSeconds: Int32
}
]
}
</code></pre>
</article>
</div>
</div>
<a href="#" class="md-top md-icon" data-md-component="top" data-md-state="hidden">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg>
Back to top
</a>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: HOME" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
HOME
</div>
</div>
</a>
<a href="../Always-use-%22local%22-to-proxy-video-through-the-server-without-creating-an-account/" class="md-footer__link md-footer__link--next" aria-label="Next: Always-use-&#34;local&#34;-to-proxy-video-through-the-server-without-creating-an-account" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Always-use-"local"-to-proxy-video-through-the-server-without-creating-an-account
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/iv-org/documentation" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tracking", "navigation.expand", "navigation.top"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
<script src="../assets/javascripts/bundle.467223ff.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink