maximvanhove / youtube-api-v3-search

Searching YouTube with the YouTube Data API v3

youtube-api-v3-search

YouTube Search Google API for Node.js and Browser

Search for YouTube videos, channels, playlists and live events via Google API

• Node.js using https and in the Browser using XMLHttpRequests

• Super light no third-party libraries

• Supports the Promise API

---

Installing

Using npm:

$ npm install youtube-api-v3-search

Using cdn:

 <script src="https://unpkg.com/[email protected]/dist/youtube-api-v3-search.min.js"></script>

---

Example Usage

//Using Node

const youtubeSearch = require('youtube-api-v3-search');

---

Callbacks

/**
 * Searching YouTube.
 * @param {string} $YOUTUBE_KEY youtube api-key
 * @param {Object} $options search parameters.
 * @param {function} callback( @param error , @param result).  
 * @return {void}
 */

youtubeSearch($YOUTUBE_KEY,$options,callback);

---

Promises

Just don't callback and you'll get a Promise :)

// NOT passing callback as the 3rd argument it returns Promise
/**
 * Searching YouTube.
 * @param {string} $YOUTUBE_KEY youtube api-key
 * @param {Object} $options search parameters.
 * @return {Promise} The result of the search .
 */

youtubeSearch($YOUTUBE_KEY,$options);

---

Options

[options/parameters]

Search Options

The q parameter specifies the query term to search for.

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.

The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types. The default value is video,channel,playlist.

Acceptable values are:

• channel
• playlist
• video

Example

const options = {
  q:'nodejs',
  part:'snippet',
  type:'video'
}

YouTube API Reference Search#parameters