Getting Started

Prerequisites

YouTube.js runs on Node.js, Deno, and modern browsers.

It requires a runtime with the following features:

  • fetch
    • On Node, we use undici's fetch implementation, which requires Node.js 16.8+. If you need to use an older version, you may provide your own fetch implementation. See providing your own fetch implementation for more information.
    • The Response object returned by fetch must thus be spec compliant and return a ReadableStream object if you want to use the VideoInfo#download method. (Implementations like node-fetch return a non-standard Readable object.)
  • EventTarget and CustomEvent are required.

Installation

# NPM
npm install youtubei.js@latest

# Yarn
yarn add youtubei.js@latest

# Git (edge version)
npm install github:LuanRT/YouTube.js

# Deno
deno add npm:youtubei.js@latest

Deno (deprecated):

import { Innertube } from 'https://deno.land/x/youtubei/deno.ts';

Basic Usage

import { Innertube } from 'youtubei.js';
const innertube = await Innertube.create(/* options */);

Configuration Options

lang (string)

  • Description: Language for the session.
  • Default: en

location (string)

  • Description: Geolocation setting.
  • Default: US

account_index (number)

  • Description: Account index for multi-account sessions. Works only with cookies.
  • Default: 0

visitor_data (string)

  • Description: Persistent visitor data string for session tailoring.
  • Default: undefined

po_token (string)

  • Description: Proof of Origin Token for attestation.
  • Default: undefined

retrieve_player (boolean)

  • Description: Fetches JS player for video format deciphering.
  • Default: true

enable_safety_mode (boolean)

  • Description: Enables YouTube safety mode.
  • Default: false

generate_session_locally (boolean)

  • Description: Generates session data locally instead of retrieving it.
  • Default: false

enable_session_cache (boolean)

  • Description: Caches session data for future use.
  • Default: true

device_category (string)

  • Description: Platform type for session (DESKTOP, MOBILE, etc.).
  • Default: DESKTOP

client_type (string)

  • Description: InnerTube client type (WEB, ANDROID, etc.).
  • Default: WEB

timezone (string)

  • Description: Time zone for the session.
  • Default: *

cache (ICache)

  • Description: Cache implementation.
  • Default: undefined
  • Description: Cookies for authenticated sessions.
  • Default: undefined

fetch (FetchFunction)

  • Description: Custom fetch implementation.
  • Default: fetch