Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 1.67 KB

README.md

File metadata and controls

72 lines (50 loc) · 1.67 KB
Raw

holodex.js

NPM

A Javascript library for Holodex API.

Install

Using npm:

npm install holodex.js

Usage

API

import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({
  apiKey: '', // Provide your personal API KEY. You can acquire a API KEY via the Account Settings page.
});

// Get Usada Pekora's channel info
client.getChannel('UC1DCedRgGHBdm81E1llLhOQ').then(function (channel) {
  // handle result
  console.log(channel.name); // Pekora Ch. 兎田ぺこら
  console.log(channel.englishName); // Usada Pekora
  console.log(channel.subscriberCount); // 1540000
});

// Get Hololive's stream
client.getLiveVideos({ org: 'Hololive' }).then(function (videos) {
  // handle result
  console.log(videos);
});

CLI

live

holodex live # => get live streams of all vtubers
holodex live hololive # => get live streams from hololive talents
holodex live hololive --json # => get hololive streams in JSON format
holodex live nijisanji --json | jq -r '[.[] | {title: .title, url: ("https://www.youtube.com/watch?v="+.id)}]' # => get a list of nijisanji streams as {title: string, url: string} object in JSON format

channel

holodex channel <channel id> # => get channel info
holodex channel <channel id> -j # => get channel info in JSON

video

holodex video <video id> # => get video info
holodex video <video id> -j # => get video info in JSON

Documentation

Documentation can be found here.

License

MIT