iv-org/documentation
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/documentation synced 2024-12-25 17:02:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add '/api/v1/popular'

Browse Source
This commit is contained in:
Omar Roth 2019-06-05 22:40:29 -05:00 committed by Perflyst
parent 4a5e70825f
commit 04fd62b611
1 changed files with 38 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
API.md
View File

@ -6,12 +6,11 @@ All endpoints that return a JSON body support `&pretty=1` for printing the respo
All endpoints that return a JSON body support the [fields API](https://developers.google.com/youtube/v3/getting-started#fields) for specifying desired fields to reduce bandwidth consumption. This can be used by adding `&fields=FIELDS` with the desired fields, for example [`/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1`](https://invidio.us/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1). All endpoints that return a JSON body support the [fields API](https://developers.google.com/youtube/v3/getting-started#fields) for specifying desired fields to reduce bandwidth consumption. This can be used by adding `&fields=FIELDS` with the desired fields, for example [`/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1`](https://invidio.us/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1).
##### GET `/api/v1/stats` ##### GET `/api/v1/stats`
> Schema: > Schema:
```javascript ```$1javascript
{ {
"version": String, "version": String,
"software": { "software": {
@ -38,7 +37,7 @@ All endpoints that return a JSON body support the [fields API](https://developer
> Schema: > Schema:
```javascript ```$1javascript
{ {
"title": String, "title": String,
"videoId": String, "videoId": String,
@ -166,7 +165,7 @@ Returns annotation XML from YouTube's `/annotations_invideo` endpoint. Alternati
> Schema: > Schema:
```javascript ```$1javascript
{ {
"commentCount": Int32?, "commentCount": Int32?,
"videoId": String, "videoId": String,
@ -225,7 +224,7 @@ continuation: String
"avgViewDurationSeconds": Int32, "avgViewDurationSeconds": Int32,
"graphData": { "graphData": {
... // ...
} }
} }
``` ```
@ -262,8 +261,7 @@ Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will au
> Schema: > Schema:
``` ```javascript[
[
{ {
"title": String, "title": String,
"videoId": String, "videoId": String,
@ -305,7 +303,7 @@ region: ISO 3166 country code (default: "US")
> Schema: > Schema:
``` ```javascript
[ [
{ {
"title": String, "title": String,
@ -316,6 +314,7 @@ region: ISO 3166 country code (default: "US")
"url": String, "url": String,
"width": Int32, "width": Int32,
"height" Int32 "height" Int32
}
], ],
"lengthSeconds": Int32, "lengthSeconds": Int32,
@ -333,11 +332,41 @@ region: ISO 3166 country code (default: "US")
] ]
``` ```
##### GET `/api/v1/popular`
```
[
{
"type": "shortVideo",
"title": String,
"videoId": String,
"videoThumbnails": [
{
"quality": String,
"url": String,
"width": Int32,
"height" Int32
}
],
"lengthSeconds": Int32,
"viewCount": Int64
"author": String,
"authorId": String,
"authorUrl": String,
"published": Int64,
"publishedText": String,
}
]
```
##### GET `/api/v1/channels/:ucid` ##### GET `/api/v1/channels/:ucid`
> Schema: > Schema:
``` ```javascript
{ {
"author": String, "author": String,
"authorId": String, "authorId": String,