-
-
Notifications
You must be signed in to change notification settings - Fork 51
Possible HTTP requests and responses
Michael V. edited this page Jan 24, 2025
·
4 revisions
| Parameter | Required | Type | Description |
|---|---|---|---|
| youtubelink | Yes | string | The full youtubelink of the video you want to download. |
| format | No | string | The format to download. Allowed formats: mp3, mp4. Default: mp3 |
| delete | No | string | The youtubeid of which you want it to be deleted from storage on the server |
Allowed url formats
youtube.com/v/{vidid}
youtube.com/vi/{vidid}
youtube.com/?v={vidid}
youtube.com/?vi={vidid}
youtube.com/watch?v={vidid}
youtube.com/watch?vi={vidid}
youtu.be/{vidid}
On error
| Parameter | Type | Description |
|---|---|---|
| error | boolean | true |
| message | string | A simple message or the error message |
No error
| Parameter | Type | Description |
|---|---|---|
| error | boolean | false |
| youtube_id | string | The youtube identifier |
| title | string | The title of the video that got converted |
| alt_title | string | A secondary title of the video |
| duration | integer | The duration of the video that got converted (in seconds) |
| file | string | The streamlink or downloadable mp3 file |
| uploaded_at | object | A Date object |
| Parameter | Required | Type | Description |
|---|---|---|---|
| delete | Yes | string | The youtubeid that has to be deleted from storage on the server |
| format | No | string | The format of the video that has to be deleted. Allowed formats: mp3, mp4. Default: all |
| Parameter | Required | Type | Description |
|---|---|---|---|
| q | Yes | string | The query term to search for video's |
| max_results | No | integer | The max results of search results u want to get |
| Parameter | Type | Description |
|---|---|---|
| error | boolean | Whether or not an error occured |
| message | string | An error message |
| results | array | An array with MAX_RESULTS entries. Each entry has: the video id, the channel name of the video, the video title and the full url to the video |
Retrieve information about any youtube video.
| Parameter | Required | Type | Description |
|---|---|---|---|
| q(uery) | Yes | string | A video id or link |
Response (200)
| Parameter | Type | Description |
|---|---|---|
| error | false | Whether or not an error occured |
| id | string | The video id |
| url | string | The video url |
| channel_url | string | The url of the youtube channel the video is from |
| channel_id | string | The id of the channel |
| channel | string | The name of the channel |
| title | string | The video title |
| duration | integer | The length of the video in seconds |
| description | string | The video description |
| published_at | string | ISO formatted publish date |