Skip to main content

Snippets & FAQ

This page contains snippets and FAQ related to Youtubei, with the assumption that this is how you declare the client:

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

const youtube = new Client();

and all of the codes are running inside an async function.

How to search for a video?​

const videos = await youtube.search("Keyword", {
    type: "video",
});

console.log(videos.items);

How to get search result from next pagination?​

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.

How to get all videos in a playlist?​

const playlist = await youtube.getPlaylist(PLAYLIST_ID);

await playlist.videos.next(0);

console.log(playlist.videos.items);

How to get video's comments?​

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

How to listen to chat event on live video?​

// 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

How to use OAuth?​

// 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);

Alternatively, you can use OAuth static helper class to authorize and obtain a refresh token:

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,
    },
});

How to use Proxy​

You can proxy your request using http-proxy-agent or https-proxy-agent by passing the agent instance to the client's fetchOptions

import { HttpsProxyAgent } from "https-proxy-agent";

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