youtube-playlist-export

Node.js command line app for exporting video data from a YouTube playlist to a JSON/CSV file.

About

This app lets you download the metadata of each video (e.g. video title, URL, uploader, and etc.) from a public/unlisted YouTube playlist and saves it to a JSON or CSV file.

> 🚨 This app does not download videos from a YouTube playlist. It only downloads text-based metadata of videos from a playlist.

Installation

> ⚠️ Requires Node v12 or higher.

1. Install the app:
``
$ npm install -g youtube-playlist-export
`
2. Run the following command in Terminal to confirm that it's properly installed:
`
$ ytpl-export --help
`
3. Get a YouTube API v3 key for free:

- 3 min. YouTube tutorial - How to Get YouTube API Key 2021
- RapidAPI blog article - How To Get a YouTube API Key (in 7 Simple Steps)

4. Run the following command and follow the on-screen instructions to register the YouTube API key:
`
$ ytpl-export key
`

Usage

`
$ ytpl-export --help
`

`
Exports video data from a YouTube playlist to JSON/CSV file.

Usage: ytpl-export [options] [command]

Options:
-V, --version output the version number
-h, --help display help for command

Commands:
id [options] Export video metadata of a playlist by its playlist ID.
key Manage your YouTube API key.
config [options] Edit configurations of this app.
help [command] display help for command
`

$3

Export a YouTube playlist given its playlist ID.

`
$ ytpl-export id
`

To find the playlist ID, head to the playlist homepage and copy the value of the list parameter in the URL (https://www.youtube.com/playlist?list=[playlistId]). For example, the Google Search Stories playlist has a playlist ID of PLBCF2DAC6FFB574DE.

!Demo of "id" command

#### Flags

- -d/--default - Skip all prompt questions and use the default configurations

#### Exportable Items

| Item | JSON/CSV Key Name |
| ------------------------- | ----------------- |
| Position in the playlist¹ | position |
| Title | title |
| Uploader | uploader |
| Uploader URL | uploaderUrl |
| Description | description |
| Video privacy | videoPrivacy |
| Publish time (UTC) | publishTime |

¹ Playlist position starts from 0

#### Save Location

You can specify the absolute path of a folder where the files will be saved to. The default value is ~/ytpl-export. The folder will be created if it doesn't exist.

Since it requires an absolute path, here are same examples:

- ✔️ C:\Users\User\Downloads (Windows)
- ✔️ /usr/ytpl-export (Mac/Linux)
- ❌ ../ytpl-export

#### Example Output

The app outputs the following when running ytpl-export id PLBCF2DAC6FFB574DE:

$3

Register, modify, or delete your YouTube API key.

`
$ ytpl-export key
`

First-time users for registering YouTube API key:

!Demo of "key" command for first-time users

After registering the API key:

!Demo of "key" command after registered API key

> ✔️ Your API key will only be stored in your local computer.

$3

Configure preferences of this app.

`
$ ytpl-export config
`

!Demo of "config" command

#### Flags

- -p/--path - Show the path of the where the config file is stored
- -r/--reset - Reset all configurations to default values (see below)

#### Default Config

- Items to export: Position in the playlist, Title, Uploader, URL
- File extension: JSON
- Save location: ~/ytpl-export
- Notify updates: Enabled
- Skip private/deleted videos: True

Development

$3

`bash


1. Install yarn if you haven't

`bash
$ node dist/cli.js
`

$3

All tests are written in Jest and they are located in the tests folder. To run all tests:

`bash
$ yarn test

Alternatively, run this to generate a coverage report

Note that clearMocks is set to true`, which Jest will automatically clear mock calls and instances before every test.

Limitations

This app uses YouTube API v3 under the hood. However, due to limitations of the API, it cannot perform the following actions:

- Export your "Watch Later" playlist
- Export private playlists
- Export most metadata of deleted or private videos, such as the original video title and description
- Download each video, not its metadata, in mp3, mp4, wmv, or other formats

Related Work

- youtube-playlist-summary - A module for getting YouTube playlist data
- usetube - A module for crawling YouTube data without a YouTube API key