Netherworld's Pretend Minibar
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

youtube-search

1.1.4 • Public • Published

youtube-search

build status JavaScript Style Guide

Easily search for videos on Youtube using their v3 API.

Options

You can pass a lot of optional parameters as the second parameter, they are documented here.

Rate limiting

Google enforces a rate limit on the Youtube Data API. You will probably need to register your application for a key and supply this key in the opts.

JavaScript Usage

var search = require('youtube-search');
 
var opts = {
  maxResults: 10,
  key: 'yourkey'
};
 
search('jsconf', opts, function(err, results) {
  if(err) return console.log(err);
 
  console.dir(results);
});

TypeScript Usage

A TypeScript definition file is included so that 'youtube-search' can be used easily from TypeScript.

import * as youtubeSearch from "youtube-search";
 
var opts: youtubeSearch.YouTubeSearchOptions = {
  maxResults: 10,
  key: "yourkey"
};
 
youtubeSearch("jsconf", opts, (err, results) => {
  if(err) return console.log(err);
 
  console.dir(results);
});

Tests

To run the tests you need a Youtube v3 API key:

API_KEY=<your-api-key> npm test

Install

npm i youtube-search

DownloadsWeekly Downloads

7,634

Version

1.1.4

License

BSD

Unpacked Size

7.22 kB

Total Files

6

Last publish

Collaborators

  • avatar