ytsr
    TypeScript icon, indicating that this package has built-in type declarations

    3.6.0 • Public • Published

    node-ytsr

    NPM version NPM downloads codecov Known Vulnerabilities Discord

    Simple js only package to search for Youtube for Videos, Playlists and many more. Does not require any login or Google-API-Key.

    Support

    You can contact us for support on our chat server

    Usage

    const ytsr = require('ytsr');
    
    const searchResults = await ytsr('github');

    API

    ytsr(searchString, [options])

    Searches for the given string

    • searchString

      • search string or url (from getFilters) to search from
    • options

      • object with options
      • possible settings:
      • gl[String] -> 2-Digit Code of a Country, defaults to US - Allows for localisation of the request
      • hl[String] -> 2-Digit Code for a Language, defaults to en - Allows for localisation of the request
      • safeSearch[Boolean] -> pull items in youtube restriction mode.
      • limit[integer] -> limits the pulled items, defaults to 100, set to Infinity to get the whole list of search results - numbers <1 result in the default being used
      • pages[Number] -> limits the pulled pages, pages contain 20-30 items, set to Infinity to get the whole list of search results - numbers <1 result in the default limit being used - overwrites limit
      • requestOptions[Object] -> Additional parameters to passed to miniget, which is used to do the https requests
    • returns a Promise

    • Example response

    ytsr.getFilters(searchString, options)

    Pulls avaible filters for the given string or link

    Usage

    const ytsr = require('ytsr');
    
    const filters1 = await ytsr.getFilters('github');
    const filter1 = filters1.get('Type').get('Video');
    const filters2 = await ytsr.getFilters(filter1.url);
    const filter2 = filters2.get('Features').get('Live');
    const options = {
      pages: 2,
    }
    const searchResults = await ytsr(filter2.url, options);
    • searchString
      • string to search for
      • or previously optained filter ref
    • options
      • gl[String] -> 2-Digit Code of a Country, defaults to US - Allows for localisation of the request
      • hl[String] -> 2-Digit Code for a Language, defaults to en - Allows for localisation of the request
      • requestOptions[Object] -> Additional parameters to passed to miniget, which is used to do the https requests
    • returns a Promise resulting in a Map<String, Map<String, Filter>>
    • Example response

    ytsr.continueReq(continuationData)

    Continues a previous request by pulling yet another page.
    The previous request had to be done using pages limitation.

    Usage

    const ytsr = require('ytsr');
    
    const firstResultBatch = await ytsr('github', { pages: 1 });
    const secondResultBatch = ytsr.continueReq(firstResultBatch.continuation);
    const thirdResultBatch = ytsr.continueReq(secondResultBatch.continuation);
    
    // You can now use the .items property of all result batches e.g.:
    console.log(firstResultBatch.items);
    console.log(secondResultBatch.items);
    console.log(thirdResultBatch.items);
    • returns a Promise resolving into { continuation, items }

    Related / Works well with

    Install

    npm install --save ytsr
    

    License

    MIT

    Install

    npm i ytsr

    DownloadsWeekly Downloads

    12,221

    Version

    3.6.0

    License

    MIT

    Unpacked Size

    44 kB

    Total Files

    7

    Last publish

    Collaborators

    • timeforaninja