Youtubei

https://suspiciouslookingowl.github.io/youtubei/docs
Admin
Youtubei is a Node.js library for interacting with the YouTube API, allowing developers to search...
Tokens:6,158
Snippets:76
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install youtubei package

Source: https://suspiciouslookingowl.github.io/youtubei/docs

Run this command in your terminal to install the library as a dependency.

```bash
npm i youtubei
```

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

### Initialize Youtubei Client

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Basic setup for the Youtubei client using CommonJS or ES6 modules.

```javascript
const { Client } = require("youtubei");  
// or for TS / ES6  
import { Client } from "youtubei";  
  
const youtube = new Client();  
```

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

### OAuth.authorize

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/OAuth

Starts the authorization process, optionally in manual mode.

```APIDOC
## Static authorize(): Promise<AuthenticateResponse>
## Static authorize(manual: true): Promise<AuthorizeResponse>

### Description
Starts the authorization process. If manual is set to true, returns an AuthorizeResponse.

### Parameters
- **manual** (true) - Optional - Flag to trigger manual authorization.

### Returns
- **Promise<AuthenticateResponse | AuthorizeResponse>** - A promise that resolves to the authorization response.
```

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

### Define Chapter Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Represents a video chapter with a start time, thumbnail, and title.

```typescript
type Chapter = {
  start: number
  thumbnails: Thumbnails
  title: string
}
```

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

### playChat(delay)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/LiveVideo

Starts polling for live chat requests with an optional delay.

```APIDOC
## playChat(delay)

### Description
Starts polling for get live chat requests.

### Parameters
- **delay** (number) - Optional - Chat delay in milliseconds (default: 0)

### Returns
- **void**
```

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

### Get Full Video Object

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoCompact

Fetches the full video object associated with the current compact video ID. This is equivalent to calling the client's getVideo method.

```typescript
client.getVideo(videoCompact.id);
```

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

### get(translationLanguageCode?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/CaptionLanguage

Retrieves the captions for the language using the associated URL, optionally specifying a translation language code.

```APIDOC
## get(translationLanguageCode?)

### Description
Fetches the captions for this language using the internal URL. Optionally accepts a translation language code to filter or translate the results.

### Parameters
- **translationLanguageCode** (string) - Optional - The language code to use for translation.

### Returns
- **Promise<undefined | Caption[]>** - A promise that resolves to an array of Caption objects or undefined if no captions are found.
```

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

### Get Video Transcript

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoCompact

Retrieves the transcript for the video if available. This is a convenience method equivalent to calling the client's getVideoTranscript method with the video ID.

```typescript
client.getVideoTranscript(video.id);
```

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

### Initialize and search with youtubei

Source: https://suspiciouslookingowl.github.io/youtubei/docs

Demonstrates importing the clients and performing a search query. Ensure you are using an async context to await the search results.

```javascript
const { Client, MusicClient } = require("youtubei");  
// or for TS / ES6  
import { Client, MusicClient } from "youtubei";  
  
const youtube = new Client();  
const music = new MusicClient();  
  
(async () => {  
    const result = await youtube.search("Never gonna give you up", {  
        type: "video", // video | playlist | channel | all  
    });  
    console.log(result.items);  
  
    const musicResult = await youtube.search("Never gonna give you up");  
    console.log(musicResult);  
})();
```

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

### new Client(options?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Initializes a new instance of the YouTube Client.

```APIDOC
## constructor

### Description
Initializes a new instance of the YouTube Client.

### Parameters
- **options** (Partial<HTTPOptions>) - Optional - Configuration options for the client.
```

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

### new MusicClient(options?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/MusicClient

Initializes a new instance of the MusicClient.

```APIDOC
## constructor

### Description
Initializes a new MusicClient instance.

### Parameters
- **options** (Partial<HTTPOptions>) - Optional - Configuration options for the HTTP client.
```

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

### Fetch channel videos using ChannelVideos

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelVideos

Demonstrates how to initialize a channel search and use the next() method to paginate through video results.

```javascript
const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});  
await channel.videos.next();  
console.log(channel.videos.items) // first 30 videos  
  
let newVideos = await channel.videos.next();  
console.log(newVideos) // 30 loaded videos  
console.log(channel.videos.items) // first 60 videos  
  
await channel.videos.next(0); // load the rest of the videos in the channel
```

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

### Fetch live videos from a channel

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelLive

Demonstrates how to retrieve and paginate through live videos using the next() method on a channel's live property.

```javascript
const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});  
await channel.live.next();  
console.log(channel.live.items) // first 30 live videos  
  
let newLives = await channel.videos.next();  
console.log(newLives) // 30 loaded live videos  
console.log(channel.live.items) // first 60 live videos  
  
await channel.live.next(0); // load the rest of the live videos in the channel
```

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

### Configure OAuth Authentication

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Initialize the client with OAuth credentials or use the static helper to obtain a refresh token.

```javascript
// initialize the client with OAuth enabled  
const youtube = new Client({  
    oauth: {  
        enabled: true,  
        refreshToken: "", // optional, if you have refresh token  
    },  
});  
  
// make any request with the client  
await youtube.getVideo();  
// if you don't have a valid refresh token, the client will print out an URL and code to authorize  
// e.g. [youtubei] Open https://www.google.com/device and enter XXX-XXX-XXX  
// once the authorization is done, the client store the refresh token for future use  
  
// printing out the refresh token, so you can store it for future use  
console.log(youtube.oauth.refreshToken);  
```

```javascript
import { OAuth, Client } from "youtubei";  
  
const response = await OAuth.authorize(); / will print out an URL and code  
  
console.log(response);  
  
/**  
{  
    accessToken: '...';  
    expiresIn: 5000;  
    refreshToken: '...';  
    scope: '...';  
    tokenType: '...';  
}  
*/  
  
// then you can use the refresh token when initializing the client  
const client = new Client({  
    oauth: {  
        enabled: true,  
        refreshToken: response.refreshToken,  
    },  
});  
```

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

### Fetch channel playlists

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelPlaylists

Demonstrates how to retrieve playlists from a channel and load subsequent pages using the next() method.

```javascript
const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});  
await channel.playlists.next();  
console.log(channel.playlists.items) // first 30 playlists  
  
let newPlaylists = await channel.playlists.next();  
console.log(newPlaylists) // 30 loaded playlists  
console.log(channel.playlists.items) // first 60 playlists  
  
await channel.playlists.next(0); // load the rest of the playlists in the channel
```

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

### Fetching and Paginating Search Results

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/MusicSearchResult

Demonstrates how to perform an initial search and retrieve subsequent pages of results, which are then aggregated into the items property.

```javascript
const result = await music.search("Keyword", "song");  
  
console.log(result.items); // search result from first page  
  
let nextSearchResult = await result.next();  
console.log(nextSearchResult); // search result from second page  
  
nextSearchResult = await result.next();  
console.log(nextSearchResult); // search result from third page  
  
console.log(result.items); // search result from first, second, and third page.  
```

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

### Fetch and paginate playlist videos

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/PlaylistVideos

Demonstrates retrieving a playlist and using the next() method to load additional videos. Setting the count to 0 will attempt to load all remaining videos in the playlist.

```javascript
const playlist = await youtube.getPlaylist(PLAYLIST_ID);  
console.log(playlist.videos) // first 100 videos  
  
let newVideos = await playlist.videos.next();  
console.log(newVideos) // 100 loaded videos  
console.log(playlist.videos) // first 200 videos  
  
await playlist.videos.next(0); // load the rest of the videos in the playlist  
```

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

### Fetch channel shorts

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelShorts

Demonstrates how to retrieve shorts from a channel using the next() method and access the items array.

```javascript
const channel = await youtube.findOne(CHANNEL_NAME, {type: "channel"});  
await channel.short.next();  
console.log(channel.short.items) // first 30 shorts  
  
let newShorts = await channel.short.next();  
console.log(newShorts) // 30 loaded shorts  
console.log(channel.short.items) // first 60 shorts  
  
await channel.short.next(0); // load the rest of the shorts in the channel  
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelLive

Fetches the next set of live videos using a continuation token. The count parameter determines how many batches of items to load.

```APIDOC
## next(count?)

### Description
Fetches the next items from the channel's live video list using a continuation token.

### Method
next(count?: number): Promise<VideoCompact[]>

### Parameters
- **count** (number) - Optional - The number of batches to load. Defaults to 1.

### Returns
- **Promise<VideoCompact[]>** - A promise that resolves to an array of VideoCompact objects.
```

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

### Search for Videos

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Perform a search query for videos using the client instance.

```javascript
const videos = await youtube.search("Keyword", {  
    type: "video",  
});  
  
console.log(videos.items);  
```

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

### findOne(query, options?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Searches for videos, playlists, or channels and returns the first result.

```APIDOC
## findOne

### Description
Search for videos, playlists, or channels and returns the first result.

### Parameters
- **query** (string) - Required - The search query string.
- **options** (T) - Optional - Search options.

### Returns
- **Promise<undefined | SearchResultItem<T['type']>>** - The first search result or undefined.
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/PlaylistVideos

Fetches the next set of videos from the playlist. The count parameter determines how many times to load the next batch of videos, with 0 loading all remaining videos.

```APIDOC
## next(count?)

### Description
Fetch next items using a continuation token to retrieve more videos from the playlist.

### Parameters
- **count** (number) - Optional - Default: 1. How many times to load the next videos. Set 0 to load all videos.

### Returns
- **Promise<VideoCompact[]>** - A promise that resolves to an array of VideoCompact objects.
```

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

### Configure Proxy

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Route requests through a proxy by providing an agent instance to the client's fetchOptions.

```javascript
import { HttpsProxyAgent } from "https-proxy-agent";  
  
const proxyAgent = new HttpsProxyAgent(`https://${user}:${pass}@${host}:${port}`);  
const client = new Client({  
    fetchOptions: {  
        agent: proxyAgent,  
    },  
});  
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelVideos

Fetches the next set of videos from the channel using a continuation token. The count parameter determines how many pages of results to fetch.

```APIDOC
## next(count?)

### Description
Fetch next items using continuation token.

### Parameters
#### Parameters
- **count** (number) - Optional - Default: 1. The number of pages to fetch.

### Returns
- **Promise<VideoCompact[]>** - A promise that resolves to an array of VideoCompact objects.
```

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

### Listen to Live Chat

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Attach an event listener to a live video to process incoming chat messages.

```javascript
// get the video  
const video = await youtube.getVideo(LIVE_VIDEO_ID);  
  
// add event listener  
video.on("chat", (chat) => {  
    console.log(`${chat.author.name}:  ${chat.message}`);  
});  
  
video.playChat(5000); // start chat polling with 5000ms chat delay  
  
video.stopChat(); // stop chat polling  
```

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

### Accessing the next video or playlist

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/BaseVideo

The upNext accessor provides a shortcut to the first item in the related videos or playlists list.

```typescript
video.related.items[0]
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelPlaylists

Fetches the next set of playlists for the channel using a continuation token. The count parameter determines how many batches of items to load.

```APIDOC
## next(count?)

### Description
Fetches the next items from the channel's playlist collection using a continuation token.

### Method
Method: next(count?: number)

### Parameters
- **count** (number) - Optional - The number of batches to load. Defaults to 1.

### Returns
- **Promise<PlaylistCompact[]>** - A promise that resolves to an array of PlaylistCompact objects.
```

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

### getPlaylist()

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/PlaylistCompact

Retrieves the full Playlist object associated with the current compact playlist instance.

```APIDOC
## getPlaylist()

### Description
Retrieves the full Playlist object based on the current playlist ID. This is equivalent to calling `client.getPlaylist(playlistCompact.id)`.

### Returns
- **Promise<Playlist>** - A promise that resolves to the full Playlist object.
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoComments

Fetches the next set of comments for the video. The count parameter determines how many times to trigger the next load operation, with 0 loading all remaining comments.

```APIDOC
## Method: next(count?)

### Description
Fetches next items using a continuation token. This method is used to paginate through video comments.

### Parameters
- **count** (number) - Optional - How many times to load the next comments. Set 0 to load all comments. Defaults to 1.

### Returns
- **Promise<Comment[]>** - A promise that resolves to an array of Comment objects.

### Example
```javascript
const video = await youtube.getVideo(VIDEO_ID);
// Load next 20 comments
await video.comments.next();
// Load all remaining comments
await video.comments.next(0);
```
```

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

### next(count?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/ChannelShorts

Fetches the next set of shorts from the channel. The count parameter determines how many batches of shorts to load.

```APIDOC
## next(count?)

### Description
Fetch next items using continuation token.

### Method
Method

### Parameters
#### Parameters
- **count** (number) - Optional - The number of batches to fetch. Defaults to 1.

### Returns
- **Promise<VideoCompact[]>** - A promise that resolves to an array of VideoCompact items.
```

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

### Accessing Video Captions

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoCaptions

Demonstrates how to list available caption languages and retrieve captions for a specific language code.

```javascript
  
console.log(video.captions.languages.map((l) => `${l.code} - ${l.name}`)); // printing out available languages for captions  
  
console.log(await video.captions.get("en")); // printing out captions of a specific language using language code  

```

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

### search(query, options?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Searches for videos, playlists, or channels based on a query.

```APIDOC
## search

### Description
Searches for videos, playlists, or channels.

### Parameters
- **query** (string) - Required - The search query.
- **options** (T) - Optional - Search options.

### Returns
- **Promise<SearchResult<T['type']>>** - The search results.
```

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

### Define PotOptions Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Configuration for Proof of Token (POT) authentication.

```typescript
type PotOptions = {
  token: string
  visitorData: string
}
```

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

### getVideo<T>()

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoCompact

Retrieves the full Video or LiveVideo object associated with the current compact video ID.

```APIDOC
### getVideo<T>()

#### Description
Fetches the full video details based on the current video ID. This is equivalent to calling client.getVideo with the video's ID.

#### Type Parameters
- **T** (Video | LiveVideo) - The expected return type of the video object.

#### Returns
- **Promise<T>** - A promise that resolves to the full video object.
```

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

### next(count?: number): Promise<T[]>

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Continuable

Fetches the next set of items in a paginated list using the internal continuation token.

```APIDOC
## next(count?: number): Promise<T[]>

### Description
Fetches the next items in the sequence using the stored continuation token. This method is used to implement pagination for various YouTube content types.

### Parameters
- **count** (number) - Optional - The number of pages or items to fetch. Defaults to 1.

### Returns
- **Promise<T[]>** - A promise that resolves to an array of items of type T.
```

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

### next(count?: number)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/CommentReplies

Fetches the next set of replies for the comment using a continuation token.

```APIDOC
## next(count?: number)

### Description
Fetches the next items in the reply thread using the continuation token. Returns a promise that resolves to an array of Reply objects.

### Parameters
- **count** (number) - Optional - The number of items to fetch. Defaults to 1.

### Returns
- **Promise<Reply[]>** - A promise that resolves to an array of Reply objects.
```

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

### min

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/Thumbnails

Retrieves the thumbnail with the lowest resolution, typically the first element in the array.

```APIDOC
## get min()

### Description
Returns the thumbnail with the lowest resolution, usually the first element of the Thumbnails array.

### Returns
- **string | undefined** - The URL of the lowest resolution thumbnail or undefined if not available.

### Example
```javascript
const min = video.thumbnails.min;
```
```

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

### Handle Search Pagination

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Retrieve subsequent pages of search results using the next() method.

```javascript
const videos = await youtube.search("Keyword", {  
    type: "video",  
});  
  
console.log(videos.items); // search result from first page  
  
let nextVideos = await videos.next();  
console.log(nextVideos); // search result from second page  
  
nextVideos = await videos.next();  
console.log(nextVideos); // search result from third page  
  
console.log(videos.items); // search result from first, second, and third page.  
```

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

### best

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/Thumbnails

Retrieves the thumbnail with the highest resolution, typically the last element in the array.

```APIDOC
## get best()

### Description
Returns the thumbnail with the highest resolution, usually the last element of the Thumbnails array.

### Returns
- **string | undefined** - The URL of the highest resolution thumbnail or undefined if not available.

### Example
```javascript
const best = video.thumbnails.best;
```
```

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

### Define ClientOptions Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Alias for HTTP configuration options used by the client.

```typescript
type ClientOptions = HTTPOptions
```

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

### Define ChannelShelf Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Represents a shelf containing channels, videos, or playlists with an optional subtitle.

```typescript
type ChannelShelf = Shelf<BaseChannel[] | VideoCompact[] | PlaylistCompact[]> & { subtitle?: string }
```

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

### Retrieve Playlist Videos

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Fetch all videos from a specific playlist ID.

```javascript
const playlist = await youtube.getPlaylist(PLAYLIST_ID);  
  
await playlist.videos.next(0);  
  
console.log(playlist.videos.items);  
```

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

### getPlaylist(playlistId)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Retrieves playlist information and its videos by ID or URL.

```APIDOC
## getPlaylist

### Description
Get playlist information and its videos by playlist id or URL.

### Parameters
- **playlistId** (string) - Required - The playlist ID or URL.

### Returns
- **Promise<T>** - The playlist information.
```

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

### searchAll(query)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/MusicClient

Performs a broad search for all content types.

```APIDOC
## searchAll(query)

### Description
Searches for all types of content including video, song, album, playlist, or artist.

### Parameters
- **query** (string) - Required - The search query.

### Returns
- **Promise<MusicSearchResult<undefined>>** - A promise that resolves to the search results.
```

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

### Fetch Video Comments

Source: https://suspiciouslookingowl.github.io/youtubei/docs/snippets-faq

Load and retrieve comments from a video, including pagination support.

```javascript
const video = await youtube.getVideo(VIDEO_ID);  
  
let comments = await video.comments.next();  
console.log(comments.items); // first 20 comments  
  
comments = await video.comments.next();  
console.log(comments.items); // next 20 comments  
  
console.log(video.comments.items); // all 40 loaded comments  
  
await video.comments.next(0); // load the rest of the comments  
console.log(video.comments.items); // all comments on the video  
```

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

### getVideo(videoId)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Retrieves video information by ID or URL.

```APIDOC
## getVideo

### Description
Get video information by video id or URL.

### Parameters
- **videoId** (string) - Required - The video ID or URL.

### Returns
- **Promise<T>** - The video information.
```

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

### getTranscript(languageCode?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/VideoCompact

Retrieves the transcript for the video if it exists. This is equivalent to calling client.getVideoTranscript with the video's ID.

```APIDOC
### getTranscript(languageCode?)

#### Description
Fetches the transcript for the video. Returns a Promise that resolves to an array of Caption objects or undefined if no transcript is available.

#### Parameters
- **languageCode** (string) - Optional - The language code for the desired transcript.

#### Returns
- **Promise<undefined | Caption[]>** - A promise containing the transcript captions or undefined.
```

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

### OAuth.authenticate

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/OAuth

Authenticates the user to obtain a token and refresh token using the code provided from the authorize method.

```APIDOC
## Static authenticate(code: string): Promise<AuthenticateResponse>

### Description
Authenticates to obtain a token and refresh token using the code from the authorize method.

### Parameters
- **code** (string) - Required - Code obtained from the authorize method.

### Returns
- **Promise<AuthenticateResponse>** - A promise that resolves to the authentication response.
```

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

### Retrieve the minimum resolution thumbnail

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/Thumbnails

Access the thumbnail with the lowest resolution, typically the first element in the array.

```typescript
const min = video.thumbnails.min;  
```

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

### Retrieve full Playlist object

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/PlaylistCompact

Fetches the complete Playlist object using the current playlist's ID.

```typescript
client.getPlaylist(playlistCompact.id);
```

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

### Define HTTPOptions Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Configuration object for HTTP requests, including API keys and client identification.

```typescript
type HTTPOptions = {
  apiKey: string
  baseUrl: string
  clientName: string
  clientVersion: string
  fetchOptions?: Partial<RequestInit>
  initialCookie?: string
  oauth?: OAuthOptions
  pot?: PotOptions
  rawResponseLogPath?: string
  youtubeClientOptions?: Record<string, unknown>
}
```

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

### search<T>(query, type?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/MusicClient

Searches for specific types of content on YouTube Music.

```APIDOC
## search<T>(query, type?)

### Description
Searches for video, song, album, playlist, or artist based on the provided query and type.

### Parameters
- **query** (string) - Required - The search query.
- **type** (T) - Optional - The specific search type (MusicSearchType).

### Returns
- **Promise<MusicSearchResult<T>>** - A promise that resolves to the search results.
```

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

### getVideoTranscript(videoId, languageCode?)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Retrieves the transcript or captions for a specific video.

```APIDOC
## getVideoTranscript

### Description
Get video transcript / caption by video id.

### Parameters
- **videoId** (string) - Required - The video ID.
- **languageCode** (string) - Optional - The language code for the transcript.

### Returns
- **Promise<undefined | Caption[]>** - An array of captions or undefined.
```

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

### Define OAuthOptions Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Configuration for OAuth authentication, including refresh token support.

```typescript
type OAuthOptions = {
  enabled: boolean
  refreshToken?: string
}
```

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

### Define SearchOptions Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Configuration object for refining search results.

```typescript
type SearchOptions = {
  duration?: SearchDuration
  features?: SearchFeature[]
  sortBy?: SearchSort
  type?: SearchType
  uploadDate?: SearchUploadDate
}
```

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

### Retrieve the best resolution thumbnail

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/Thumbnails

Access the thumbnail with the highest resolution, typically the last element in the array.

```typescript
const best = video.thumbnails.best;  
```

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

### getLyrics(id)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/MusicClient

Retrieves the lyrics for a specific song by its ID.

```APIDOC
## getLyrics(id)

### Description
Fetches the lyrics of a song using its unique identifier.

### Parameters
- **id** (string) - Required - The ID of the song.

### Returns
- **Promise<undefined | MusicLyrics>** - A promise that resolves to the lyrics or undefined if not found.
```

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

### getChannel(channelId)

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/Client

Retrieves channel information by its unique ID.

```APIDOC
## getChannel

### Description
Get channel information by channel id.

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

### Returns
- **Promise<undefined | Channel>** - The channel information or undefined.
```

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

### OAuth.refreshToken

Source: https://suspiciouslookingowl.github.io/youtubei/docs/music/classes/OAuth

Refreshes an existing access token using a refresh token.

```APIDOC
## Static refreshToken(refreshToken: string): Promise<RefreshResponse>

### Description
Refreshes the authentication token using the provided refresh token.

### Parameters
- **refreshToken** (string) - Required - The refresh token string.

### Returns
- **Promise<RefreshResponse>** - A promise that resolves to the refresh response.
```

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

### Define SearchUploadDate Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Allowed upload date filters for search queries.

```typescript
type SearchUploadDate = "all" | "hour" | "today" | "week" | "month" | "year" | UploadDate
```

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

### Define SearchType Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Allowed content types for search queries.

```typescript
type SearchType = "all" | "video" | "channel" | "playlist" | Type
```

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

### Define SearchResultItem Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Generic type mapping for search result items based on the requested type.

```typescript
type SearchResultItem<T> = T extends "video" | VideoCompact ? VideoCompact : T extends "channel" | BaseChannel ? BaseChannel : T extends "playlist" | PlaylistCompact ? PlaylistCompact : VideoCompact | BaseChannel | PlaylistCompact
```

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

### Define OAuthProps Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Properties for OAuth tokens and expiration status.

```typescript
type OAuthProps = {
  expiresAt: Date | null
  refreshToken?: string
  token: string | null
}
```

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

### Define SearchSort Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Allowed sorting methods for search results.

```typescript
type SearchSort = "relevance" | "rating" | "date" | "view" | Sort
```

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

### stopChat()

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/classes/LiveVideo

Stops the request polling for live chat.

```APIDOC
## stopChat()

### Description
Stop request polling for live chat.

### Returns
- **void**
```

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

### Define SearchFeature Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Allowed feature filters for search queries.

```typescript
type SearchFeature = "live" | "4k" | "hd" | "subtitles" | "creativeCommons" | "360" | "vr180" | "3d" | "hdr" | "location" | Feature
```

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

### Define SearchDuration Type Alias

Source: https://suspiciouslookingowl.github.io/youtubei/docs/youtube/modules

Allowed duration filters for search queries.

```typescript
type SearchDuration = "all" | "short" | "medium" | "long" | Duration
```
Tokens:
Raw