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 2019-02-25 09:47:40 -06:00
parent 5a519515de
commit 3de4647e8a
1 changed files with 89 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
API.md
View File

@ -48,8 +48,8 @@
"allowRatings": Bool, "allowRatings": Bool,
"rating": Float32, "rating": Float32,
"isListed": Bool?, "isListed": Bool?,
"hlsUrl": String?,
"hlsUrl": String?,
"adaptiveFormats": [ "adaptiveFormats": [
{ {
"index": String, "index": String,
@ -155,6 +155,8 @@ continuation: String
##### GET `/api/v1/insights/:id` ##### GET `/api/v1/insights/:id`
**Will always return 503: `YouTube has removed publicly-available analytics`***
> Schema: > Schema:
```javascript ```javascript
@ -225,7 +227,11 @@ Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will au
"published": Int64, "published": Int64,
"publishedText": String, "publishedText": String,
"description": String, "description": String,
"descriptionHtml": String "descriptionHtml": String,
"liveNow": Bool,
"paid": Bool,
"premium": Bool
} }
] ]
``` ```
@ -289,11 +295,14 @@ Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will au
"subCount": Int32, "subCount": Int32,
"totalViews": Int64, "totalViews": Int64,
"joined": Int64, "joined": Int64,
"paid": Bool, "paid": Bool,
"autoGenerated": Bool,
"isFamilyFriendly": Bool, "isFamilyFriendly": Bool,
"description": String, "description": String,
"descriptionHtml": String, "descriptionHtml": String,
"allowedRegions": Array(String), "allowedRegions": Array(String),
"latestVideos": [ "latestVideos": [
{ {
"title": String, "title": String,
@ -319,6 +328,20 @@ Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will au
"paid": Bool, "paid": Bool,
"premium": Bool "premium": Bool
} }
],
"relatedChannels": [
{
"author": String,
"authorId": String,
"authorUrl": String,
"authorThumbnails": [
{
"url": String,
"width": Int32,
"height": Int32
}
]
}
] ]
} }
``` ```
@ -362,7 +385,7 @@ Note that a channel's username (if it doesn't include spaces) is also valid in p
paid: Bool, paid: Bool,
premium: Bool premium: Bool
} }
]; ]
``` ```
Parameters: Parameters:
@ -372,6 +395,69 @@ page: Int32
sort_by: "newest", "oldest", "popular" (default: newest) sort_by: "newest", "oldest", "popular" (default: newest)
``` ```
##### GET `/api/v1/channels/:ucid/latest`, `/api/v1/channels/latest/:ucid`
```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
}
]
```
##### GET `/api/v1/channels/playlists/:ucid`, `/api/v1/channels/:ucid/playlists`
```javascript
{
"playlists": [
{
"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
}
]
}
]
],
"continuation": String?
}
```
##### GET `/api/v1/channels/search/:ucid` ##### GET `/api/v1/channels/search/:ucid`
> Schema: > Schema: