/simpleYT

Simple youtube search library without need of an API key

Primary LanguageJavaScriptMIT LicenseMIT

simpleYT

install size image

image

Simple youtube search library without need of an api key

Usage

If you intend to use this library on a browser, use jsDelivr:

<script src="https://cdn.jsdelivr.net/gh/kimcore/simpleyt@latest/browser/simpleyt.min.js"></script>

and then you can use require('simpleyt') like the example below:

const simpleYT = require('simpleyt')
const query = 'very long playlist'
simpleYT(query, {
    filter: 'video', 
    // Available filters: video, playlist

    localAddress: '2001:470:1234:5678::a',
    family: 6
    // Other parameters are passed to miniget (https)
}).then(console.log)

Result

[
  {
      type: 'video',
      identifier: 'nPuHl_Hl2xI',
      uri: 'https://www.youtube.com/watch?v=nPuHl_Hl2xI',
      title: '12 HOURS LONG RELAX MUSIC - Relaxation, Meditation, Sleep and Spa Music by RELAX CHANNEL ☯188',
      author: {
        name: 'RELAX CHANNEL',
        profile: 'https://yt3.ggpht.com/a-/AOh14GiqEKfh0k2lWpQVJU18CYULkb9XL2g8i7Jd2A=s68-c-k-c0x00ffffff-no-rj-mo',
        uri: 'https://www.youtube.com/user/relaxvideoschannel'
      },
      length: { ms: 42888000, sec: 42888 },
      isStream: false,
      thumbnails: [
          {
              url: 'https://i.ytimg.com/vi/nPuHl_Hl2xI/hqdefault.jpg?sqp=-oaymwEjCOADEI4CSFryq4qpAxUIARUAAAAAGAElAADIQj0AgKJDeAE=&rs=AOn4CLDtSUSrI3HJLkr-7mEnNfVYjVVLqQ',
              width: 480,
              height: 270
          }
      ]
    },
    ...
    {
      type: 'playlist',
      identifier: 'PLAhZL8hvPmBGp4RpHNHThexBegcjYxcC-',
      uri: 'https://www.youtube.com/playlist?list=PLAhZL8hvPmBGp4RpHNHThexBegcjYxcC-',
      title: 'The very long music playlist',
      author: {
        name: 'Humphreys Samuel',
        uri: 'https://www.youtube.com/channel/UC0fAfWQXyTVN-R7NP0BWwGA'
      },
      count: 1000,
      thumbnails: [
          {
              url: 'https://i.ytimg.com/vi/WhmlNt42pjk/hqdefault.jpg?sqp=-oaymwEWCKgBEF5IWvKriqkDCQgBFQAAiEIYAQ==&rs=AOn4CLCG_urfC1u0JDVyJYBQd3tJ7Tb0kQ',
              width: 168,
              height: 94
          },
          {
              url: 'https://i.ytimg.com/vi/0aG4E5jJKtQ/default.jpg',
              width: 43,
              height: 20
          }
      ]
    },
    ...
]