iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2024-12-23 06:19:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated API (markdown)

Browse Source
This commit is contained in:
Omar Roth 2018-11-04 19:00:02 -06:00
parent bda6d708cc
commit 1890cad427
1 changed files with 57 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
API.md
View File

@ -25,6 +25,8 @@
"likeCount": Int32, "likeCount": Int32,
"dislikeCount": Int32, "dislikeCount": Int32,
"paid": Bool,
"premium": Bool,
"isFamilyFriendly": Bool, "isFamilyFriendly": Bool,
"allowedRegions": Array(String), "allowedRegions": Array(String),
"genre": String, "genre": String,
@ -33,11 +35,19 @@
"author": String, "author": String,
"authorId": String, "authorId": String,
"authorUrl": String, "authorUrl": String,
"authorThumbnails": [
{
"url": String,
"width": Int32,
"height": Int32
}
],
"subCountText": String,
"lengthSeconds": Int32, "lengthSeconds": Int32,
"allowRatings": Bool, "allowRatings": Bool,
"rating": Float32, "rating": Float32,
"isListed": Bool, "isListed": Bool?,
"hlsUrl": String?, "hlsUrl": String?,
"adaptiveFormats": [ "adaptiveFormats": [
@ -176,9 +186,12 @@ Parameters:
``` ```
label: String label: String
lang: String
tlang: String
``` ```
A request with `label` will return the selected captions in WebVTT format. A request with `label` will return the selected captions in WebVTT format.
Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will auto-translate from English into the requested language (if English captions are available).
##### GET `/api/v1/trending` ##### GET `/api/v1/trending`
@ -297,12 +310,16 @@ A request with `label` will return the selected captions in WebVTT format.
"viewCount": Int64, "viewCount": Int64,
"published": Int64, "published": Int64,
"publishedText": String, "publishedText": String,
"lengthSeconds": Int32 "lengthSeconds": Int32,
"paid": Bool,
"premium": Bool
} }
] ]
} }
``` ```
Note that a channel's username (if it doesn't include spaces) is also valid in place of `ucid`, e.g. `/api/v1/channels/BlenderFoundation`.
##### GET `/api/v1/channels/:ucid/videos`, `/api/v1/channels/videos/:ucid` ##### GET `/api/v1/channels/:ucid/videos`, `/api/v1/channels/videos/:ucid`
> Schema: > Schema:
@ -331,6 +348,8 @@ A request with `label` will return the selected captions in WebVTT format.
published: Int64, published: Int64,
publishedText: String, publishedText: String,
lengthSeconds: Int32 lengthSeconds: Int32
paid: Bool,
premium: Bool
} }
]; ];
``` ```
@ -368,7 +387,9 @@ page: Int32
published: Int64, published: Int64,
publishedText: String, publishedText: String,
lengthSeconds: Int32, lengthSeconds: Int32,
liveNow: Bool liveNow: Bool,
paid: Bool,
premium: Bool
}, },
{ {
type: "playlist", type: "playlist",
@ -450,7 +471,9 @@ page: Int32
published: Int64, published: Int64,
publishedText: String, publishedText: String,
lengthSeconds: Int32, lengthSeconds: Int32,
liveNow: Bool liveNow: Bool,
paid: Bool,
premium: Bool
}, },
{ {
type: "playlist", type: "playlist",
@ -562,3 +585,33 @@ Parameters:
``` ```
page: Int32 page: Int32
``` ```
##### GET `/api/v1/mixes/:rdid`
> Schema:
```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
}
]
}
```