Skip to content

Androz2091/node-ytsr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM version NPM downloads Dependencies Dependencies

NPM info

node-ytsr

Simple js only module to search YouTube Doesn't need any login or GoogleAPI key

Usage

const ytsr = require('ytsr');
let filter;

ytsr.getFilters('github', function(err, filters) {
  if(err) throw err;
  filter = filters.get('Type').find(o => o.name === 'Video');
  ytsr.getFilters(filter.ref, function(err, filters) {
    if(err) throw err;
    filter = filters.get('Duration').find(o => o.name.startsWith('Short'));
    var options = {
      limit: 5,
      nextpageRef: filter.ref,
    }
    ytsr(null, options, function(err, searchResults) {
      if(err) throw err;
      dosth(searchResults);
    });
  });
});

API

ytsr(searchString, [options, callback])

Searches for the given string

  • searchString

    • string to search for
  • options

    • object with options
    • possible settings:
    • safeSearch[Boolean] -> pull items in youtube restriction mode.
    • limit[integer] -> limits the pulled items
    • nextpageRef[String] -> if u wanna continue a previous search or use filters
  • callback(err, result)

    • function
    • getting fired after the request is done
    • contains an error or a result
  • returns a Promise when no callback is defined

  • Example response

ytsr.getFilters(searchString, [callback])

Pulls avaible filters for the given string/ref

  • searchString

    • string to search for
    • or previously optained filter ref
  • callback(err, result)

    • function
    • getting fired after the request is done
    • contains an error or a result
  • returns a Promise when no callback is defined

  • Example response

Related / Works well with

Install

npm install --save ytsr

License

MIT

About

Do anonymous YouTube search requests.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 97.3%
  • JavaScript 2.7%