### Example API Request with Include Parameters

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

This example demonstrates how to construct a GET request to the /videos endpoint, specifying additional data to be included in the response using the 'include' query parameter.

```http
GET /videos?org=Hololive&include=description,songs,mentions
```

--------------------------------

### Install holodex.js using npm

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Use this command to install the holodex.js library via npm.

```bash
npm install holodex.js
```

--------------------------------

### Video.scheduledStart

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/classes/Video.html

Retrieves the scheduled start date and time for a future stream.

```APIDOC
## Video.scheduledStart

### Description
Gets the date when the stream was scheduled to start.

### Method
GET

### Endpoint
N/A (Class Property)

### Returns
- **Date**: The scheduled start date.
```

--------------------------------

### CLI Usage

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/index.html

Examples of using the holodex.js CLI for various operations.

```APIDOC
## CLI Commands

### `holodex live`

Retrieves live streams.

- **Usage**:
  - `holodex live` - Get live streams of all VTubers.
  - `holodex live <organization>` - Get live streams from a specific organization (e.g., `holodex live hololive`).
  - `holodex live <organization> --json` - Get live streams in JSON format.
  - `holodex live <organization> --json | jq -r '[.[] | {title: .title, url: ("https://www.youtube.com/watch?v=" + .id)}]'` - Get a list of streams as JSON objects with title and URL.

### `holodex channel <channelId>`

Retrieves information about a specific channel.

- **Usage**:
  - `holodex channel <channel id>` - Get channel info.
  - `holodex channel <channel id> -j` - Get channel info in JSON format.

### `holodex video <videoId>`

Retrieves information about a specific video.

- **Usage**:
  - `holodex video <video id>` - Get video info.
  - `holodex video <video id> -j` - Get video info in JSON format.
```

--------------------------------

### Get Live Streams via CLI

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/index.html

Use the holodex CLI to fetch live streams. You can specify an organization or get all live streams. JSON output is available with the --json flag.

```bash
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
```

--------------------------------

### Import Holodex.js API

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/6_module_structure.md

Demonstrates how to import all public APIs from the holodex.js library. Ensure the library is installed.

```typescript
import {
  HolodexApiClient,
  Channel,
  Video,
  Comment,
  Song,
  ChannelType,
  VideoType,
  VideoStatus,
  VideoSearchType,
  SortOrder,
  ExtraData,
  ChannelsParam,
  VideosParam,
  ChannelVideosParam,
  Options,
  ORGS
} from 'holodex.js';
```

--------------------------------

### Get video info using CLI

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Retrieve video information using the CLI. Use the '-j' flag for JSON output.

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

--------------------------------

### Initialize HolodexApiClient with Environment Variable

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

It is common practice to store your API key in an environment variable for security. This example shows how to use `process.env.HOLODEX_API_KEY`.

```typescript
import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({
  apiKey: process.env.HOLODEX_API_KEY
});
```

--------------------------------

### Get Channel's Videos by Type

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Retrieve videos uploaded by a channel, clips featuring the channel, or collaborations mentioning the channel.

```typescript
// Videos uploaded by channel
const uploads = await client.getVideosByChannelId(channelId, 'videos');

// Clips featuring channel
const clips = await client.getVideosByChannelId(channelId, 'clips');

// Collaborations mentioning channel
const collabs = await client.getVideosByChannelId(channelId, 'collabs');
```

--------------------------------

### Get Japanese Streams with Descriptions

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieves live streams in Japanese, including their descriptions in the response.

```APIDOC
## GET /videos (with description)

### Description
Retrieves live streams for a specified language and includes descriptions in the response.

### Method
GET

### Endpoint
/videos

### Parameters
#### Query Parameters
- **lang** (string) - Required - The language code for filtering streams (e.g., "ja").
- **type** (string) - Required - Specifies the type of content to retrieve (e.g., "stream").
- **include** (string) - Optional - Specifies additional data to include in the response (e.g., "description").
```

--------------------------------

### Get channel info using CLI

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Retrieve channel information using the CLI. Use the '-j' flag for JSON output.

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

--------------------------------

### Get Live Videos by Organization

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Fetch currently live videos from a specific organization, such as 'Hololive'. The result is a list of video objects.

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

--------------------------------

### Get Live Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Fetches a list of currently live VTuber streams, with optional filtering by organization.

```APIDOC
## getLiveVideos

### Description
Fetches a list of currently live VTuber streams, with optional filtering by organization.

### Method
`client.getLiveVideos(options?: { org?: string })`

### Parameters
#### Query Parameters
- **org** (string) - Optional - Filters live streams by the organization name (e.g., 'Hololive').

### Request Example
```javascript
const live = await client.getLiveVideos({ org: 'Hololive' });
console.log(live.length);
```

### Response
#### Success Response (200)
- **length** (number) - The number of live streams found.
```

--------------------------------

### Handle API Pagination

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Iterate through paginated results by managing an offset and checking for the presence of more items. This example fetches channels in batches.

```typescript
let offset = 0;
let hasMore = true;

while (hasMore) {
  const channels = await client.getChannels({
    limit: 50,
    offset: offset
  });
  
  if (channels.length < 50) hasMore = false;
  // Process channels...
  offset += 50;
}
```

--------------------------------

### Get live streams of all vtubers using CLI

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

This CLI command retrieves live streams for all vtubers. It can also filter by organization and output in JSON format.

```bash
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
```

--------------------------------

### Get Japanese Streams with Descriptions

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieve Japanese streams and include their descriptions in the response.

```http
# Get Japanese streams with descriptions
GET /videos?lang=ja&type=stream&include=description
```

--------------------------------

### HolodexApiClient Methods

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/INDEX.md

Reference for the HolodexApiClient class, including its constructor and all 7 public methods for interacting with the Holodex API. This section details method signatures, parameters, return types, and provides code examples.

```APIDOC
## HolodexApiClient Class Reference

This section details the `HolodexApiClient` class, its constructor, and all public methods available for interacting with the Holodex API.

### Constructor
Initializes a new instance of the `HolodexApiClient`.

### Methods

#### `getChannels()`
Lists and filters available channels.

#### `getChannel(channelId)`
Retrieves details for a single specified channel.

#### `getVideosByChannelId(channelId)`
Fetches all videos associated with a specific channel ID.

#### `getVideo(videoId)`
Retrieves details for a single video, with an option to include comments.

#### `getLiveVideos()`
Fetches a list of currently live streams across Holodex.

#### `getLiveVideosByChannelId(channelId)`
Provides an efficient way to check the live status of a specific channel.

#### `getVideos(options)`
Performs advanced video searches with various filtering and sorting options.
```

--------------------------------

### Build a Live Status Dashboard

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Get live streaming status for an organization, including total channels, live count, and live stream details.

```typescript
async function getLiveStatusByOrg(org: string) {
  const live = await client.getLiveVideos({ org });
  const channels = await client.getChannels({ org });
  
  return {
    organization: org,
    totalChannels: channels.length,
    liveCount: live.length,
    livePercentage: Math.round((live.length / channels.length) * 100),
    streams: live.map(v => ({
      title: v.title,
      channel: v.channel.englishName,
      viewers: v.liveViewers || 0
    }))
  };
}

// Usage
const hololiveStatus = await getLiveStatusByOrg('Hololive');
console.log(`${hololiveStatus.liveCount}/${hololiveStatus.totalChannels} Hololive channels live`);
```

--------------------------------

### Implement Retry Logic for Rate Limiting

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

Implement backoff logic if you receive 429 (Too Many Requests) responses. This example shows how to retry requests with exponential backoff.

```typescript
async function getChannelsWithRetry() {
  let attempts = 0;
  while (attempts < 3) {
    try {
      return await client.getChannels();
    } catch (error: any) {
      if (error.response?.status === 429) {
        const delay = 1000 * Math.pow(2, attempts);
        await new Promise(r => setTimeout(r, delay));
        attempts++;
      } else {
        throw error;
      }
    }
  }
}
```

--------------------------------

### Get Live Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Retrieves currently live streams matching the given parameters. This endpoint is optimized for real-time data and returns results faster than the general getVideos() endpoint.

```typescript
async getLiveVideos(params?: VideosParam): Promise<Video[]>
```

```typescript
// Get all live streams
const allLive = await client.getLiveVideos();
```

```typescript
// Get live streams from Hololive only
const hololiveLive = await client.getLiveVideos({
  org: 'Hololive'
});
```

```typescript
// Get live streams with extra data
const liveWithSongs = await client.getLiveVideos({
  org: 'Nijisanji',
  include: ['songs', 'mentions']
});
```

--------------------------------

### Get Videos with Filters

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Retrieves videos matching specified filter and sort parameters. This is the most flexible endpoint for video queries, allowing extensive filtering options. Default parameters are used if none are specified.

```typescript
async getVideos(params?: VideosParam): Promise<Video[]>
```

```typescript
// Get recent videos from all organizations
const recent = await client.getVideos({
  limit: 50
});
```

```typescript
// Get upcoming streams
const upcoming = await client.getVideos({
  status: 'upcoming',
  sort: 'start_scheduled',
  order: 'asc'
});
```

```typescript
// Get clips in Japanese with song information
const japaneseClips = await client.getVideos({
  type: 'clip',
  lang: 'ja',
  include: ['songs']
});
```

```typescript
// Complex query: upcoming Hololive collaborations with descriptions
const hololiveCollabs = await client.getVideos({
  org: 'Hololive',
  status: 'upcoming',
  mentioned_channel_id: 'UC1DCedRgGHBdm81E1llLhOQ',
  include: ['description', 'mentions'],
  limit: 25
});
```

--------------------------------

### Get Channel's Videos, Clips, or Collaborations

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Retrieve different types of videos associated with a channel, including uploaded videos, clips, or collaborations. Supports pagination and filtering.

```typescript
const videos = await client.getVideosByChannelId(
  'UC1DCedRgGHBdm81E1llLhOQ',
  'videos',
  { limit: 10 }
);

videos.forEach(v => {
  console.log(`${v.title} - ${v.duration}s`);
});

// Get clips of a channel
const clips = await client.getVideosByChannelId(
  'UC1DCedRgGHBdm81E1llLhOQ',
  'clips'
);

// Get collaborations mentioning a channel
const collabs = await client.getVideosByChannelId(
  'UC1DCedRgGHBdm81E1llLhOQ',
  'collabs'
);
```

--------------------------------

### ExtraData Enum and Usage Example

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/2_types.md

Specifies additional data fields that can be included in video responses. Use the 'include' parameter with these values to fetch specific details like clips, songs, or live information.

```typescript
enum ExtraData {
  Clips = 'clips',
  Refers = 'refers',
  Sources = 'sources',
  Simulcasts = 'simulcasts',
  Mentions = 'mentions',
  Description = 'description',
  LiveInfo = 'live_info',
  ChannelStats = 'channel_stats',
  Songs = 'songs'
}
```

```typescript
const videos = await client.getVideos({
  include: ['description', 'songs', 'mentions']
});

videos.forEach(video => {
  console.log(video.description); // Now populated
  console.log(video.songs); // Song array
  console.log(video.mentions); // Mentioned channels
});
```

--------------------------------

### GET /channels

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieves a list of channels with support for filtering, sorting, and pagination. Allows users to find channels based on various criteria like language, organization, and type.

```APIDOC
## GET /channels

### Description
List channels with filtering and pagination.

### Method
GET

### Endpoint
/channels

### Parameters
#### Query Parameters
- **lang** (string) - No - Comma-separated language codes
- **limit** (number) - No - Results per page (max 50) - Default: 25
- **offset** (number) - No - Pagination offset - Default: 0
- **order** (string) - No - Sort direction: 'asc' or 'desc' - Default: 'asc'
- **org** (string) - No - Organization filter
- **sort** (string) - No - Field to sort by - Default: 'org'
- **type** (string) - No - Channel type: 'vtuber' or 'subber'

### Response
#### Success Response (200 OK)
- **id** (string) - YouTube channel ID
- **name** (string) - Channel name
- **english_name** (string) - English channel name
- **type** (string) - Channel type ('vtuber' or 'subber')
- **org** (string) - Organization name
- **suborg** (string) - Sub-organization name
- **group** (string) - Group name
- **photo** (string) - URL to the channel's photo
- **banner** (string) - URL to the channel's banner
- **twitter** (string) - Twitter handle
- **video_count** (string) - Total number of videos
- **subscriber_count** (string) - Total number of subscribers
- **view_count** (string) - Total view count
- **clip_count** (number) - Total number of clips
- **lang** (string) - Primary language code
- **published_at** (string) - Channel creation date (ISO 8601)
- **inactive** (boolean) - Whether the channel is inactive
- **description** (string) - Channel description

### Response Example
{
  "example": "[\n  {\n    \"id\": \"UC1DCedRgGHBdm81E1llLhOQ\",\n    \"name\": \"Pekora Ch. 兎田ぺこら\",\n    \"english_name\": \"Usada Pekora\",\n    \"type\": \"vtuber\",\n    \"org\": \"Hololive\",\n    \"suborg\": \"Hololive JP\",\n    \"group\": \"Hololive JP\",\n    \"photo\": \"https://...\",\n    \"banner\": \"https://...\",\n    \"twitter\": \"usadapekora\",\n    \"video_count\": \"1234\",\n    \"subscriber_count\": \"1540000\",\n    \"view_count\": \"150000000\",\n    \"clip_count\": 5678,\n    \"lang\": \"ja\",\n    \"published_at\": \"2018-06-01T10:23:45Z\",\n    \"inactive\": false,\n    \"description\": \"...\"\n  }\n]"
}
```

--------------------------------

### Get Upcoming Streams

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Fetches upcoming streams scheduled within the next 24 hours, sorted by their scheduled start time.

```APIDOC
## GET /videos (upcoming)

### Description
Retrieves upcoming streams, sorted by scheduled start time, with a limit on how far in the future to look.

### Method
GET

### Endpoint
/videos

### Parameters
#### Query Parameters
- **status** (string) - Required - Filters videos by their status (e.g., "upcoming").
- **sort** (string) - Required - The field to sort videos by (e.g., "start_scheduled").
- **order** (string) - Required - The order of sorting (e.g., "asc").
- **max_upcoming_hours** (integer) - Required - The maximum number of hours into the future to search for upcoming streams.
- **include** (string) - Optional - Specifies additional data to include in the response (e.g., "live_info").
```

--------------------------------

### Initialize HolodexApiClient and Fetch Data

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Demonstrates initializing the HolodexApiClient with an API key and fetching channel or live stream data. Ensure you replace 'your-api-key-here' with your actual API key.

```typescript
import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({
  apiKey: 'your-api-key-here'
});

// Get a channel
const channel = await client.getChannel('UC1DCedRgGHBdm81E1llLhOQ');
console.log(channel.englishName); // Usada Pekora

// Get live streams
const live = await client.getLiveVideos({ org: 'Hololive' });
console.log(live.length); // Number of live streams
```

--------------------------------

### Get Upcoming Streams in Next 24 Hours

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Find upcoming streams scheduled within the next 24 hours, sorted by scheduled start time.

```http
# Get upcoming streams in next 24 hours
GET /videos?status=upcoming&sort=start_scheduled&order=asc&max_upcoming_hours=24&include=live_info
```

--------------------------------

### Song Constructor

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/classes/Song.html

Initializes a new Song object with raw song data.

```APIDOC
## new Song(raw: SongRaw)

### Description
Initializes a new Song object.

### Parameters
#### Parameters
- **raw** (SongRaw) - The raw song data object used for initialization.

### Returns
- **Song** - A new instance of the Song class.
```

--------------------------------

### Initialize HolodexApiClient with API Key

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

Basic client initialization requires your Holodex API key. Obtain this from your Holodex account settings.

```typescript
import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({
  apiKey: 'your-api-key-here'
});
```

--------------------------------

### constructor

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/classes/HolodexApiClient.html

Initializes a new instance of the HolodexApiClient class.

```APIDOC
## constructor

### Description
Initializes a new instance of the HolodexApiClient class.

### Parameters
#### Parameters
- **options** (Options) - Description of the options parameter.

### Returns
[HolodexApiClient]
```

--------------------------------

### HolodexApiClient Usage

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/index.html

Demonstrates how to instantiate the HolodexApiClient and use its methods to fetch channel information and live videos.

```APIDOC
## HolodexApiClient

### Description

Provides methods to interact with the Holodex API for fetching channel and video data.

### Methods

#### `getChannel(channelId: string)`

Fetches information about a specific channel.

- **Parameters**:
  - `channelId` (string) - The ID of the channel to retrieve.

- **Returns**:
  A Promise that resolves with channel data, including `name`, `englishName`, and `subscriberCount`.

#### `getLiveVideos(params?: { org: string })`

Fetches a list of live videos, optionally filtered by organization.

- **Parameters**:
  - `params` (object, optional) - An object containing filter parameters.
    - `org` (string) - The organization to filter live videos by (e.g., 'Hololive').

- **Returns**:
  A Promise that resolves with an array of live video objects.
```

--------------------------------

### Handle Pagination

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Demonstrates how to handle pagination when fetching lists of items, such as channels. This involves using `limit` and `offset` parameters to retrieve data in chunks.

```APIDOC
## Handle Pagination

### Description

Demonstrates how to handle pagination when fetching lists of items, such as channels. This involves using `limit` and `offset` parameters to retrieve data in chunks.

### Method

`getChannels(params?: ChannelsParam): Promise<Channel[]>` (Example usage with pagination)

### Parameters

#### Query Parameters (`params` for `getChannels`)

- **limit** (number) - Required - The maximum number of results to return per page.
- **offset** (number) - Required - The number of results to skip from the beginning.

### Example

```typescript
let offset = 0;
let hasMore = true;

while (hasMore) {
  const channels = await client.getChannels({
    limit: 50,
    offset: offset
  });
  
  if (channels.length < 50) hasMore = false;
  // Process channels...
  offset += 50;
}
```
```

--------------------------------

### Get Channel

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Retrieves information about a specific VTuber channel using its ID.

```APIDOC
## getChannel

### Description
Retrieves information about a specific VTuber channel using its ID.

### Method
`client.getChannel(channelId: string)`

### Parameters
#### Path Parameters
- **channelId** (string) - Required - The unique identifier of the channel.

### Request Example
```javascript
const channel = await client.getChannel('UC1DCedRgGHBdm81E1llLhOQ');
console.log(channel.englishName);
```

### Response
#### Success Response (200)
- **englishName** (string) - The English name of the channel.
```

--------------------------------

### Initialize HolodexApiClient and Fetch Channel Info

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/index.html

Initialize the HolodexApiClient with an API key and fetch channel information. Ensure you have a personal API key from the Account Settings page.

```javascript
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
});
```

--------------------------------

### Initialize HolodexApiClient

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Initialize the client with your API key. Ensure the HOLODEX_API_KEY environment variable is set.

```typescript
import { HolodexApiClient } from 'holodex.js';

// Initialize the client with your API key
const client = new HolodexApiClient({
  apiKey: process.env.HOLODEX_API_KEY || ''
});
```

--------------------------------

### Get Hololive Channels

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieve a list of Hololive VTuber channels, limited to 50 results.

```http
# Get Hololive channels
GET /channels?org=Hololive&type=vtuber&limit=50
```

--------------------------------

### Get Live Status for Specific Channels

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Checks the live status for a provided list of channel IDs.

```APIDOC
## GET /users/live

### Description
Retrieves the live status for a specified list of channels.

### Method
GET

### Endpoint
/users/live

### Parameters
#### Query Parameters
- **channels** (string) - Required - A comma-separated list of channel IDs to check the live status for.
```

--------------------------------

### Get Live Status for Specific Channels

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Check the live status for a comma-separated list of channel IDs.

```http
# Get live status for specific channels
GET /users/live?channels=UC1DCedRgGHBdm81E1llLhOQ,UCdyqAaZDKHXg4nM7-4K_sw
```

--------------------------------

### Initialize Holodex API Client

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Instantiate the HolodexApiClient with an API key. Provide your personal API KEY obtained from the Account Settings page.

```javascript
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 Recent Hololive Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Fetch the 25 most recent videos from Hololive, sorted in descending order.

```http
# Get recent videos from Hololive
GET /videos?org=Hololive&sort=available_at&order=desc&limit=25
```

--------------------------------

### HolodexApiClient Constructor

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Initializes a new HolodexApiClient instance. It accepts an Options object for configuration, including an API key and an optional custom API URL. The client is configured with automatic retry logic for network errors and idempotent request failures.

```APIDOC
## Constructor HolodexApiClient

### Description
Creates a new Holodex API client instance with automatic retry logic.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **options** (Options) - Required - Configuration object containing API key and optional custom URL

### Request Example
```typescript
import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({
  apiKey: 'your-api-key-here'
});
```

### Response
None
```

--------------------------------

### Rate Limited Response Example

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

When rate-limited, the server responds with a 429 status code and a Retry-After header indicating when to retry.

```http
HTTP/1.1 429 Too Many Requests
Retry-After: 60
```

--------------------------------

### Get Recent Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Fetches recent videos, allowing filtering by organization and sorting by availability date in descending order.

```APIDOC
## GET /videos

### Description
Retrieves a list of videos, with options for filtering by organization, sorting, and limiting results.

### Method
GET

### Endpoint
/videos

### Parameters
#### Query Parameters
- **org** (string) - Optional - The organization to filter videos by (e.g., "Hololive").
- **sort** (string) - Optional - The field to sort videos by (e.g., "available_at").
- **order** (string) - Optional - The order of sorting (e.g., "desc").
- **limit** (integer) - Optional - The maximum number of videos to return.
```

--------------------------------

### holodex.js Package Details

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

This JSON object details the package name, version, description, main entry points, and binary for the holodex.js library.

```json
{
  "name": "holodex.js",
  "version": "2.0.5",
  "description": "A Javascript library for the Holodex API",
  "main": "./dist/index.js",
  "module": "./dist/index.mjs",
  "types": "./dist/index.d.ts",
  "bin": {
    "holodex": "./dist/cli.js"
  }
}
```

--------------------------------

### Channel Constructor

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/classes/Channel.html

Initializes a new instance of the Channel class.

```APIDOC
## Channel Constructor

### constructor

*   new Channel(raw: [ChannelRaw](../interfaces/ChannelRaw.html)): [Channel](Channel.html)

    *   Defined in [types/channel.ts:142](https://github.com/HolodexNet/holodex.js/blob/0cbd860/src/types/channel.ts#L142)
    
    #### Parameters
    
    *   ##### raw: [ChannelRaw](../interfaces/ChannelRaw.html)
        
    
    #### Returns [Channel](Channel.html)
```

--------------------------------

### HolodexApiClient Options

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Configuration object passed to the HolodexApiClient constructor.

```APIDOC
## Options

```typescript
interface Options {
  url?: string;
  apiKey: string;
}
```

Configuration object passed to the HolodexApiClient constructor.

| Field | Type | Required | Default |
|-------|------|----------|---------|
| apiKey | string | Yes | — |
| url | string | No | `'https://holodex.net/api/v2'` |
```

--------------------------------

### Get Hololive Channels

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieves a list of channels belonging to the Hololive organization, with options to filter by type and limit the number of results.

```APIDOC
## GET /channels

### Description
Retrieves a list of channels, filterable by organization and type.

### Method
GET

### Endpoint
/channels

### Parameters
#### Query Parameters
- **org** (string) - Required - The organization to filter channels by (e.g., "Hololive").
- **type** (string) - Optional - The type of channel to filter by (e.g., "vtuber").
- **limit** (integer) - Optional - The maximum number of channels to return.
```

--------------------------------

### Build a Video Library for a Channel

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Compile a video library for a given channel, separating uploads and clips. Fetches recent uploads and clips.

```typescript
async function buildVideoLibrary(channelId: string) {
  const [uploads, clips] = await Promise.all([
    client.getVideosByChannelId(channelId, 'videos', { limit: 50 }),
    client.getVideosByChannelId(channelId, 'clips', { limit: 50 })
  ]);
  
  return {
    channel: uploads[0]?.channel,
    stats: {
      uploads: uploads.length,
      clips: clips.length
    },
    recentUploads: uploads.slice(0, 10),
    recentClips: clips.slice(0, 10)
  };
}
```

--------------------------------

### Get Video Information

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Retrieves detailed information for a single YouTube video. Can optionally include timestamp comments and filter clips by language.

```typescript
async getVideo(
  videoId: string,
  includeComments?: boolean,
  languages?: string[] | string
): Promise<Video>
```

```typescript
// Get basic video info
const video = await client.getVideo('PL6I0JQnZlbyA');
console.log(video.title);
```

```typescript
// Get video with timestamp comments
const videoWithComments = await client.getVideo(
  'PL6I0JQnZlbyA',
  true
);

videoWithComments.comments.forEach(comment => {
  console.log(comment.content); // Usually contains timestamps
});
```

```typescript
// Get video with language filtering for clips
const localizedVideo = await client.getVideo(
  'PL6I0JQnZlbyA',
  false,
  ['en', 'ja']
);
```

--------------------------------

### Get Channel Information

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Retrieves detailed information for a single YouTube channel using its ID. Requires the channel ID as a string parameter.

```typescript
const channel = await client.getChannel('UC1DCedRgGHBdm81E1llLhOQ');
console.log(channel.name); // "Pekora Ch. 兎田ぺこら"
console.log(channel.subscriberCount); // 1540000
```

--------------------------------

### Exporting Parameters from Index

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/6_module_structure.md

This file serves as the main entry point for exporting all parameter type definitions.

```typescript
export * from './channel-videos-param';
export * from './channels-param';
export * from './options';
export * from './videos-param';
```

--------------------------------

### Get Channel's Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Retrieves videos, clips, or collaborations associated with a specific channel ID. Supports pagination and filtering options.

```APIDOC
## Get Channel's Videos

### Description
Retrieves videos, clips, or collaborations associated with a specific channel ID. Supports pagination and filtering options.

### Method Signature
`client.getVideosByChannelId(channelId: string, type: 'videos' | 'clips' | 'collabs', options?: { limit?: number })`

### Parameters
#### Path Parameters
- **channelId** (string) - Required - The unique identifier of the channel.
- **type** (string) - Required - The type of content to retrieve ('videos', 'clips', or 'collabs').
#### Query Parameters
- **options.limit** (number) - Optional - The maximum number of items to return.

### Response Example
```json
[
  {
    "title": "Example Video Title",
    "duration": 1800
  }
]
```
```

--------------------------------

### Video.availableAt

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/classes/Video.html

Retrieves the date the video was made available. It returns the first non-null value from publishedAt, actualStart, scheduledStart, or actualEnd.

```APIDOC
## Video.availableAt

### Description
Gets the date the video was made available. This takes on the first non-null value of publishedAt, actualStart, scheduledStart, or actualEnd.

### Method
GET

### Endpoint
N/A (Class Property)

### Returns
- **Date**: The date the video was made available.
```

--------------------------------

### Get Channel's Videos

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Retrieve videos, clips, or collaborations associated with a specific channel. This allows you to categorize content by its relationship to the channel.

```APIDOC
## Get Channel's Videos

### Description

Retrieve videos, clips, or collaborations associated with a specific channel. This allows you to categorize content by its relationship to the channel.

### Method

`getVideosByChannelId(channelId: string, searchType?: VideoSearchType, params?: ChannelVideosParam): Promise<Video[]>`

### Parameters

#### Path Parameters

- **channelId** (string) - Required - The unique identifier for the channel.

#### `searchType` Parameter

- **searchType** (VideoSearchType) - Optional - The type of content to retrieve. Accepted values are 'videos' (uploads), 'clips', or 'collabs'.

### Examples

```typescript
// Videos uploaded by channel
const uploads = await client.getVideosByChannelId(channelId, 'videos');

// Clips featuring channel
const clips = await client.getVideosByChannelId(channelId, 'clips');

// Collaborations mentioning channel
const collabs = await client.getVideosByChannelId(channelId, 'collabs');
```
```

--------------------------------

### Options Interface

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/interfaces/Options.html

The Options interface defines the configuration parameters for interacting with the Holodex API. It includes properties for your personal API key and the Holodex/HoloAPI Server Entrypoint.

```APIDOC
## Interface: Options

### Description

Configuration options for the Holodex API client.

### Properties

#### apiKey

- **Type**: `string`
- **Description**: Your personal API key. The validity of the key is not checked by the library, so ensure it is correct. You can acquire an API KEY via the Account Settings page.

#### url

- **Type**: `string`
- **Optional**: Yes
- **Description**: Holodex/HoloAPI Server Entrypoint.
- **Default**: `"https://holodex.net/api/v2"`
```

--------------------------------

### Get Channel Information

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/README.md

Retrieve details for a specific channel using its ID. Access properties like name, subscriber count, and organization.

```typescript
const channel = await client.getChannel('UC1DCedRgGHBdm81E1llLhOQ');
console.log(channel.englishName);      // Channel name
console.log(channel.subscriberCount);  // Subscriber count
console.log(channel.organization);     // Organization (e.g., 'Hololive')
console.log(channel.createdAt);        // Creation date
```

--------------------------------

### Monitor Upcoming Events Schedule

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Retrieve a list of upcoming events within a specified time frame, sorted by scheduled start time.

```typescript
async function getUpcomingSchedule(hours = 24) {
  const upcoming = await client.getVideos({
    status: 'upcoming',
    sort: 'start_scheduled',
    order: 'asc',
    include: ['live_info'],
    max_upcoming_hours: hours
  });
  
  return upcoming.map(video => ({
    title: video.title,
    channel: video.channel.englishName,
    organization: video.channel.organization,
    scheduledStart: video.scheduledStart,
    url: `https://youtube.com/watch?v=${video.videoId}`
  })).sort((a, b) => 
    a.scheduledStart!.getTime() - b.scheduledStart!.getTime()
  );
}

const schedule = await getUpcomingSchedule(24);
```

--------------------------------

### Holodex API Client Options

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/2_types.md

Configuration for the HolodexApiClient constructor. Requires an API key and optionally accepts a custom API endpoint URL.

```typescript
interface Options {
  apiKey: string
  url?: string
}
```

--------------------------------

### Valid Organization Values for Holodex.js Queries

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

A list of valid organization keys that can be used when filtering channels. An example demonstrates how to use these values in a query.

```typescript
// Valid org values for queries
'hololive'
'nijisanji'
'indie'
'vspo'
'vshojo'
'kizuna-ai'
'774inc'
'.live'
'noripro'
'react'
'voms'
'kamitsubaki'
'eilene'
'hoshimeguri-gakuen'
'riot-music'
'propro'
'wactor'
'aogiri-highschool'
'masquerade'
'tsunderia'
'yuni-create'
'atelier-live'
'prism'
'voice-ore'
'vivid'
'chukorara'
'x-encount'
'marbl_s'
'iridori'
'unreal-night-girls'
'v-dimension.creators

// Example usage
const hololive = await client.getChannels({ org: 'hololive' });
```

--------------------------------

### Initialize HolodexApiClient with Custom URL

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

Configure the client to use a custom API endpoint URL if you are not connecting to the default Holodex instance.

```typescript
const client = new HolodexApiClient({
  apiKey: 'your-key',
  url: 'https://custom-holodex-instance.com/api/v2'
});
```

--------------------------------

### Main Entry Point Exports

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/6_module_structure.md

Re-exports all public APIs from the client and types modules to the top level. This simplifies imports for users.

```typescript
export * from './client';
export * from './types';
```

--------------------------------

### Get Single Video Details

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Fetches detailed information for a specific video using its YouTube video ID. Optionally includes timestamped comments.

```APIDOC
## GET /videos/{videoId}

### Description
Get detailed information for a single video.

### Method
GET

### Endpoint
/videos/{videoId}

### Parameters
#### Path Parameters
- **videoId** (string) - Required - YouTube video ID

#### Query Parameters
- **c** (number) - Optional - If 1, includes timestamp comments
- **lang** (string) - Optional - Language codes (default 'all')

### Response
#### Success Response (200)
A single video object with detailed information, including comments if requested.

```json
{
  "id": "PL6I0JQnZlbyA",
  "title": "Minecraft Stream #123",
  "type": "stream",
  "topic_id": "minecraft",
  "published_at": "2024-01-15T10:00:00Z",
  "available_at": "2024-01-15T10:00:00Z",
  "duration": 3600,
  "status": "past",
  "channel_id": "UC1DCedRgGHBdm81E1llLhOQ",
  "channel": {
    "id": "UC1DCedRgGHBdm81E1llLhOQ",
    "name": "Pekora Ch. 兎田ぺこら",
    "english_name": "Usada Pekora",
    "type": "vtuber",
    "org": "Hololive",
    "inactive": false,
    "description": "..."
  },
  "comments": [
    {
      "comment_key": "key123",
      "video_id": "PL6I0JQnZlbyA",
      "message": "[1:23:45] Song title"
    }
  ],
  "songcount": 5
}
```
```

--------------------------------

### HolodexApiClient Methods

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/INDEX.md

Documentation for the public methods available on the HolodexApiClient.

```APIDOC
## HolodexApiClient Methods

This section details the 7 public methods available on the `HolodexApiClient`.

### `getChannels(params)`

Retrieves a list of channels based on the provided parameters.

### `getChannelVideos(channelId, params)`

Retrieves videos for a specific channel.

### `getVideos(params)`

Retrieves a list of videos based on the provided parameters.

### `getComments(videoId, params)`

Retrieves comments for a specific video.

### `getSongs(params)`

Retrieves a list of songs based on the provided parameters.

### `getChat(videoId)`

Retrieves the chat for a specific video.

### `getLive(params)`

Retrieves a list of currently live streams.
```

--------------------------------

### Get Currently Live Streams

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieves a list of currently live streams, optimized for performance and cost-efficiency compared to the general video search endpoint.

```APIDOC
## GET /live

### Description
Get currently live streams with default optimizations.

### Method
GET

### Endpoint
/live

### Parameters
#### Query Parameters
- **include** (string) - Optional - Comma-separated extra data
- **lang** (string) - Optional - Language codes (default 'all')
- **offset** (number) - Optional - Pagination offset (default 0)
- **org** (string) - Optional - Organization filter

### Response
#### Success Response (200)
Same format as `/videos` endpoint, but returns only live streams.
```

--------------------------------

### Import Default Constructor

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/6_module_structure.md

Import only the default constructor for the API client. This is the most minimal import if you only need to instantiate the client.

```typescript
import { HolodexApiClient } from 'holodex.js';

const client = new HolodexApiClient({ apiKey: '...' });
```

--------------------------------

### Fetch Live Videos from a Specific Organization

Source: https://github.com/holodexnet/holodex.js/blob/master/docs/index.html

Fetch live streaming videos from a specific organization, such as 'Hololive'. The result is an array of video objects.

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

--------------------------------

### Get Currently Live Streams

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/5_api_endpoints.md

Retrieve a list of currently live streams. This endpoint is optimized for performance and cost-effectiveness compared to the general /videos endpoint.

```typescript
const live = await client.getLiveVideos({
  org: 'Hololive'
});
```

--------------------------------

### Get a Single Video

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

Fetches a specific video by its ID. You can access basic video properties like title, type, status, duration, and publication date.

```APIDOC
## Get a Single Video

### Description
Fetches a specific video by its ID. You can access basic video properties like title, type, status, duration, and publication date.

### Method Signature
`client.getVideo(videoId: string)`

### Parameters
#### Path Parameters
- **videoId** (string) - Required - The unique identifier of the video.

### Response Example
```json
{
  "title": "Example Video Title",
  "videoType": "stream",
  "status": "live",
  "duration": 3600,
  "publishedAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Load Environment Variables with Dotenv

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/3_configuration.md

For development, use a `.env` file and the `dotenv` package to load environment variables, including your API key.

```bash
# .env
HOLODEX_API_KEY=your-actual-key-here
```

```typescript
import dotenv from 'dotenv';
dotenv.config();

const client = new HolodexApiClient({
  apiKey: process.env.HOLODEX_API_KEY!
});
```

--------------------------------

### HolodexApiClient Options

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/1_api_client.md

Configuration object for the HolodexApiClient constructor. Requires an apiKey and optionally accepts a custom API url.

```typescript
interface Options {
  url?: string;
  apiKey: string;
}
```

--------------------------------

### Get Channel Information

Source: https://github.com/holodexnet/holodex.js/blob/master/README.md

Retrieve information about a specific YouTube channel using its ID. Displays the channel's name, English name, and subscriber count.

```javascript
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
});
```

--------------------------------

### Retrieve Videos with Descriptions and Songs

Source: https://github.com/holodexnet/holodex.js/blob/master/_autodocs/4_examples.md

This snippet retrieves videos with extended data, including descriptions, associated songs, and clip counts. It's useful for detailed video analysis.

```typescript
// Retrieve videos with rich data
const richVideos = await client.getVideos({
  org: 'Hololive',
  include: ['description', 'songs', 'clips'],
  limit: 10
});

richVideos.forEach(video => {
  console.log(`=== ${video.title} ===`);
  console.log(video.description);
  
  if (video.songs.length > 0) {
    console.log('Songs:');
    video.songs.forEach(song => {
      console.log(`  ${song.name} by ${song.artist} [${song.startTime}s - ${song.endTime}s]`);
    });
  }
  
  if (video.clips.length > 0) {
    console.log(`Has ${video.clips.length} clips`);
  }
});
```