# youtube-node

> Youtube API v3 client for nodeJS

Latest version **1.3.3** (published 2019-01-29) · 0 weekly downloads

## Install

```sh
npm install youtube-node
pnpm add youtube-node
yarn add youtube-node
bun add youtube-node
```

Provides the command `youtube`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2019-01-29 |
| First published | 2013-07-03 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 62 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 109 |
| Author | Paulo McNally |
| Maintainers | paulomcnally |
| Keywords | youtube, videos, api |

## Links

- npm: https://www.npmjs.com/package/youtube-node
- Repository: https://github.com/paulomcnally/youtube-node
- Homepage: https://github.com/paulomcnally/youtube-node#readme
- Issues: https://github.com/paulomcnally/youtube-node/issues/new
- npm.io page: https://npm.io/package/youtube-node

## Dependencies (3)

- [colors](https://npm.io/package/colors.md) ^1.3.3
- [prompt](https://npm.io/package/prompt.md) ^1.0.0
- [request](https://npm.io/package/request.md) ^2.88.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.3.3 (latest) — 2019-01-29
- 1.3.2 — 2017-07-02
- 1.3.1 — 2017-07-02
- 1.3.0 — 2015-08-07
- 1.2.0 — 2015-03-09
- 1.1.4 — 2015-03-09
- 1.1.3 — 2015-02-28
- 1.1.2 — 2014-12-07
- 1.1.1 — 2014-12-07
- 1.1.0 — 2014-12-07
- 1.0.1 — 2014-03-02
- 1.0.0 — 2014-03-02
- 0.0.4 — 2014-03-02
- 0.0.3 — 2014-03-01
- 0.0.2 — 2013-12-11
- … 1 more at https://npm.io/package/youtube-node/versions

## README

# youtube-node [![Dependency Status](https://david-dm.org/paulomcnally/youtube-node.png)](https://david-dm.org/paulomcnally/youtube-node) [![NPM version](https://badge.fury.io/js/youtube-node.png)](http://badge.fury.io/js/youtube-node)

[![NPM](https://nodei.co/npm/youtube-node.png?downloads=true)](https://nodei.co/npm/youtube-node/)

* YouTube API v3 - Require key ([video](https://www.youtube.com/watch?v=Im69kzhpR3I))
* CLI

## CLI

For use CLI need install youtube-node using -g param.

    $ npm install youtube-node -g

#### CLI Example getById ( require key and video ID )

    $ youtube id


#### CLI Example search (require key, query and maxResults)

    $ youtube search

## Usage

#### Installation
    $ npm install youtube-node

#### Example search (search term, num results, <optional>params, callback) return object
    var YouTube = require('youtube-node');

    var youTube = new YouTube();

    youTube.setKey('AIzaSyB1OOSpTREs85WUMvIgJvLTZKye4BVsoFU');

    youTube.search('World War z Trailer', 2, function(error, result) {
      if (error) {
        console.log(error);
      }
      else {
        console.log(JSON.stringify(result, null, 2));
      }
    });

See output: [https://gist.github.com/paulomcnally/620b76a9afe81f56e8c9](https://gist.github.com/paulomcnally/620b76a9afe81f56e8c9)

You can also pass in an optional params object. This is useful for paging:

    youTube.search('World War z Trailer', 2, {pageToken: 'XxXxX'}, function(error, result) {
      //as above example
    });

Page token is a property on the response - `nextPageToken` or `previousPageToken`  

#### Example getById (youtube id, result) return object
    var YouTube = require('youtube-node');

    var youTube = new YouTube();
    youTube.setKey('AIzaSyB1OOSpTREs85WUMvIgJvLTZKye4BVsoFU');

    youTube.getById('HcwTxRuq-uk', function(error, result) {
      if (error) {
        console.log(error);
      }
      else {
        console.log(JSON.stringify(result, null, 2));
      }
    });

See output: [https://gist.github.com/paulomcnally/50e0b96291c82b87009b](https://gist.github.com/paulomcnally/50e0b96291c82b87009b)

#### Example related (youtube id, maxResults, result) return object

    var YouTube = require('youtube-node');

    var youTube = new YouTube();

    youTube.setKey('AIzaSyB1OOSpTREs85WUMvIgJvLTZKye4BVsoFU');

    youTube.related('hafhSaP_Nh4', 2, function(error, result) {
      if (error) {
        console.log(error);
      }
      else {
        console.log(JSON.stringify(result, null, 2));
      }
    });

See output:
[https://gist.github.com/paulomcnally/ebab23c68c374723f28a](https://gist.github.com/paulomcnally/ebab23c68c374723f28a)

#### Optional Parameters

[https://developers.google.com/youtube/v3/docs/search/list#optional-parameters](https://developers.google.com/youtube/v3/docs/search/list#optional-parameters)

To set an optional parameter use:

    youTube.addParam('order', 'title');

### For older version use:

    $ npm install youtube-node@0.0.4

**Older version use API v2 and is not recommended**

## Those who use it?
* [http://sync.club/](http://sync.club/#dev-session)

---
_Source: https://npm.io/package/youtube-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
