iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2024-10-01 01:35:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated API (markdown)

Browse Source
This commit is contained in:
Omar Roth 2018-08-07 14:37:58 -05:00
parent ce235d87dd
commit acc5fcaea1
1 changed files with 66 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
API.md
View File

@ -34,6 +34,7 @@
"allowRatings": Bool, "allowRatings": Bool,
"rating": Float32, "rating": Float32,
"isListed": Bool, "isListed": Bool,
"hlsUrl": String?,
"adaptiveFormats": [ "adaptiveFormats": [
{ {
@ -122,11 +123,76 @@
##### GET `/api/v1/top` ##### GET `/api/v1/top`
> Schema: > Schema:
``` ```
[
{
"title": String,
"videoId": String,
"videoThumbnails": [
{
"quality": String,
"url": String,
"width": Int32,
"height" Int32
],
"lengthSeconds": Int32,
"viewCount": Int64,
"author": String,
"authorUrl": String,
"published": Int64,
"description": String,
"descriptionHtml": String
}
]
``` ```
##### GET `/api/v1/channels/:ucid` ##### GET `/api/v1/channels/:ucid`
> Schema: > Schema:
``` ```
{
"author": String,
"authorId": String,
"authorUrl": String,
"authorBanners": [
{
"url": String,
"width": Int32,
"height": Int32
}
],
"authorThumbnails": [
{
"url": String,
"width": Int32,
"height": Int32
}
],
"subCount": Int32,
"totalViews": Int64,
"joined": Int64,
"paid": Bool,
"isFamilyFriendly": Bool,
"description": String,
"allowedRegions": Array(String),
"latestVideos": [
{
"title": String,
"videoId": String,
"published": Int64,
"videoThumbnails": [
{
"quality": String,
"url": String,
"width": Int32,
"height": Int32
}
]
}
]
}
``` ```
##### GET `/api/v1/channels/:ucid/videos` ##### GET `/api/v1/channels/:ucid/videos`