https://github.com/sinedied/ystats

Simple CLI to quickly get YouTube stats for any video, playlist or channel
https://github.com/sinedied/ystats

cli nodejs npm stats views youtube

Last synced: 3 months ago
JSON representation

Simple CLI to quickly get YouTube stats for any video, playlist or channel

• Host: GitHub
• URL: https://github.com/sinedied/ystats
• Owner: sinedied
• License: mit
• Created: 2021-11-05T15:06:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-12T08:59:37.000Z (over 3 years ago)
• Last Synced: 2025-03-11T00:16:38.153Z (3 months ago)
• Topics: cli, nodejs, npm, stats, views, youtube
• Language: JavaScript
• Homepage:
• Size: 868 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# :tv: ystats

[![NPM version](https://img.shields.io/npm/v/ystats.svg)](https://www.npmjs.com/package/ystats)

[![Build Status](https://github.com/sinedied/ystats/workflows/build/badge.svg)](https://github.com/sinedied/ystats/actions)

![Node version](https://img.shields.io/node/v/ystats.svg)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

> Simple CLI to quickly get YouTube stats for any video, playlist, channel or all at once.

## Installation

```bash

npm install -g ystats

```

## Usage

```

Usage: ys [config_path_or_URL] [options]

Options:

  -i, --ids          Coma separated list of video IDs

  -p, --playlist   Playlist ID

  -c, --channel     Channel ID

  -t, --token        Use specified API token

  -o, --output            Write result to output file

  -a, --append                  Append to output file (requires -o)

  -f, --format            Output format (json, yml, csv, txt, basic)

  -t, --total                   Add section with total stats

  -v, --version                 Show version

  --help                        Show help

```

To use this tool, you need a YouTube Data API key. You can get one by looking at [the instructions here](https://developers.google.com/youtube/v3/getting-started). You can provide it with the `--token` option, setting the `YT_API_TOKEN` environment variable or adding `YT_API_TOKEN=` into a `.env` file in the current directory.

If you don't provide a config file path or URL, the tool will try to load a `ystats.yml` config file in the current directory.

Please note that the YouTube data API have [quota limits](https://developers.google.com/youtube/v3/getting-started#quota). If you are getting rate limited, you can try to use a different API token.

## IDs format

The various IDs (video, playlista and channel) can be provided in any of the following formats:

- raw id (e.g. `video_id`)

- YouTube browser URL (e.g. `https://www.youtube.com/watch?v=video_id`)

- YouTube share URL (e.g. `https://youtu.be/video_id`)

## Config file

The config file is a YAML file with the following structure:

```yaml

# List of videos IDs to get stats for

videos:

  - https://youtu.be/w-tLZjO6XMc

  - https://www.youtube.com/watch?v=FeJVdCz_uco

# List of playlist IDs to get stats for

playlists:

  - https://www.youtube.com/playlist?list=PLlrxD0HtieHje-_287YJKhY8tDeSItwtg

  - https://www.youtube.com/playlist?list=PLlrxD0HtieHgMPeBaDQFx9yNuFxx6S1VG

# List of channels IDs to get stats for

channels:

  - https://www.youtube.com/channel/UCsMica-v34Irf9KVTh6xx-g

```

Each of these sections are completely optional.