npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

yt-videos-api

v1.2.12

Published

Api client for the yt-videos api

Downloads

13

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!