documentation/API.md

207 lines
3.4 KiB
Markdown

##### GET `/api/v1/videos/:id`
> Schema:
```
{
"title": String,
"videoId": String,
"videoThumbnails": [
{
"quality": String,
"url": String,
"width": Int32,
"height": Int32
},
],
"description": String,
"descriptionHtml": String,
"published": Int64
"keywords": Array(String),
"viewCount": Int64,
"likeCount": Int32,
"dislikeCount": Int32,
"isFamilyFriendly": Bool,
"allowedRegions": Array(String),
"genre": String,
"author": String,
"authorId": String,
"authorUrl": String,
"lengthSeconds": Int32,
"allowRatings": Bool,
"rating": Float32,
"isListed": Bool,
"hlsUrl": String?,
"adaptiveFormats": [
{
"index": String,
"bitrate": String,
"init": String,
"url": String,
"itag": String,
"type": String,
"clen": String,
"lmt": String,
"projectionType": Int32,
"container": String,
"encoding": String,
"qualityLabel": String?,
"resolution": String?
},
],
"formatStreams": [
{
"url": String,
"itag": String,
"type": String,
"quality": String,
"container": String,
"encoding": String,
"qualityLabel": String,
"resolution": String,
"size": String
},
],
"captions": [
{
"label": String,
"languageCode": String
},
],
"recommendedVideos": [
{
"videoId": String,
"title": String,
"videoThumbnails": [
{
"quality": String,
"url": String,
"width": Int32,
"height": Int32
},
],
"author": String,
"lengthSeconds": Int32,
"viewCountText" String
}
]
}
```
##### GET `/api/v1/trending`
> 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/top`
> 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`
> 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`
> Schema:
```
```
##### GET `/api/v1/search`
> Schema:
```
```