Updated API (markdown)

This commit is contained in:
Omar Roth 2019-03-01 10:56:36 -06:00
parent de33669b2f
commit 9bf0093e9f

16
API.md
View File

@ -107,6 +107,12 @@
} }
``` ```
Parameters:
```
region: [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Decoding_table) (default: "US")
```
##### GET `/api/v1/comments/:id` ##### GET `/api/v1/comments/:id`
> Schema: > Schema:
@ -150,6 +156,7 @@
Parameters: Parameters:
``` ```
source: "youtube", "reddit"
continuation: String continuation: String
``` ```
@ -195,6 +202,7 @@ Parameters:
label: String label: String
lang: String lang: String
tlang: String tlang: String
region: [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Decoding_table) (default: "US")
``` ```
A request with `label` will return the selected captions in WebVTT format. A request with `label` will return the selected captions in WebVTT format.
@ -236,6 +244,13 @@ Captions can also be selected with an ISO `lang`, e.g. &lang=en, `tlang` will au
] ]
``` ```
Parameters:
```
type: "music", "gaming", "news", "movies"
region: [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Decoding_table) (default: "US")
```
##### GET `/api/v1/top` ##### GET `/api/v1/top`
> Schema: > Schema:
@ -629,6 +644,7 @@ date: "hour", "today", "week", "month", "year"
duration: "short", "long" duration: "short", "long"
type: "video", "playlist", "channel", "all", (default: video) type: "video", "playlist", "channel", "all", (default: video)
features: "hd", "subtitles", "creative_commons", "3d", "live", "purchased", "4k", "360", "location", "hdr" (comma separated: e.g. "&features=hd,subtitles,3d,live") features: "hd", "subtitles", "creative_commons", "3d", "live", "purchased", "4k", "360", "location", "hdr" (comma separated: e.g. "&features=hd,subtitles,3d,live")
region: [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Decoding_table) (default: "US")
``` ```
##### GET `/api/v1/playlists/:plid` ##### GET `/api/v1/playlists/:plid`