yt-videos-api
v1.2.12
Published
Api client for the yt-videos api
Downloads
13
Maintainers
Readme
YT-Videos API Client
Api client for the yt-videos api. You can find more info in YT-Videos API
Installing the library
npm i yt-videos-api
Getting the API KEY
You can get an api key by subscribing to the API totally free through the following link YT-Videos API
Importing the package
import YtVideoApi from "yt-videos-api";
Usage
The first thing we must do is add our API Key using the following function:
import { YtVideoAuth } from "yt-videos-api";
YtVideoAuth("YOUR-API-KEY-HERE");
Video Data
Receive data from a Youtube video
Get info from video
- Params:
| Param | required | type | | ----------- | -------- | ------ | | videoId | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getInfoFromVideo({ videoId: "HmZKgaHa3Fg" }).then((res) =>
console.log(res)
);
Captions from video
- Params:
| Param | required | type | | ----------- | -------- | ------ | | videoId | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getCaptionsFromVideo({ videoId: "HmZKgaHa3Fg" }).then((res) =>
console.log(res)
);
Comments from video
- Params:
| Param | required | type | | ----------- | -------- | ------ | | videoId | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getCommentsFromVideo({ videoId: "DjD9hXXa9WA" }).then((res) =>
console.log(res)
);
Search Data
Looking for data on Youtube such as channels, videos, etc.
Search for videos
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | max | false | number | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.searchVideo({ q: "test video", max: 10, lang: "EN" }).then((res) =>
console.log(res)
);
Search Channel
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | max | false | number | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.searchChannel({ q: "test", max: 10, lang: "EN" }).then((res) =>
console.log(res)
);
Search Movies
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | max | false | number | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.searchMovies({ q: "test", max: 10, lang: "EN" }).then((res) =>
console.log(res)
);
Search Music
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | max | false | number | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.searchMusic({ q: "test", max: 10, lang: "EN" }).then((res) =>
console.log(res)
);
Search Live
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | max | false | number | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.searchLive({ q: "test", max: 10, lang: "EN" }).then((res) =>
console.log(res)
);
Download
Allows you to download the video, audio and information about any video
Downloading video, audio and info about a video
- Params:
| Param | required | type | | ----------- | -------- | ------ | | videoId | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.downloadVideo({ videoId: "HmZKgaHa3Fg" }).then((res) =>
console.log(res)
);
Extra Data
Allows you to obtain additional information
Channel info
- Params:
| Param | required | type | | ------ | -------- | ------ | | id | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getChannelInfo({ id: "UCb8krelqxVJ5UGSDiNb4RZw" }).then((res) =>
console.log(res)
);
Playlist info
- Params:
| Param | required | type | | ------ | -------- | ------ | | id | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getPlayListInfo({
id: "4b00b114bbmsh12f64d1476daa08p193433jsnc1a6a80653d6",
}).then((res) => console.log(res));
Get Suggestions
- Params:
| Param | required | type | | -------- | -------- | ------ | | q | true | string | | lang | false | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getSuggestions({q: "music". lang: "EN"}).then((res) => console.log(res));
Trending videos
- Params:
| Param | required | type | | ------------ | -------- | ------ | | location | true | string |
- Usage:
import YtVideoApi from "yt-videos-api";
YtVideoApi.getTrendingVideos({ location: "US" }).then((res) =>
console.log(res)
);
I hope you enjoy it!