youtubei.js

A JavaScript client for YouTube's private API

YouTube.js is a JavaScript client for YouTube's private API, known as "InnerTube". It allows you to interact with YouTube programmatically, providing access to videos, comments, live chats, streaming data and more. It works seamlessly across Node.js, Deno, and modern browsers.

Installation

Before installing, make sure your environment meets the prerequisites.

# NPM
npm install youtubei.js@latest

# Yarn
yarn add youtubei.js@latest

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

Deno:

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

Basic Usage

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

For detailed usage, check out the YouTube.js Guide and API Documentation.

Contributing

We welcome all contributions, issues and feature requests, whether small or large. If you want to contribute, feel free to check out our issues page and our guidelines.

Contributors

Disclaimer

This project is not affiliated with, endorsed, or sponsored by YouTube or any of its affiliates or subsidiaries. All trademarks, logos, and brand names used in this project are the property of their respective owners and are used solely to describe the services provided.

As such, any usage of trademarks to refer to such services is considered nominative use. If you have any questions or concerns, please contact me.

License

Distributed under the MIT License.

(back to top)

Changelog

13.0.0 (2025-01-20)

⚠ BREAKING CHANGES

• Remove web.bundle.min

Features

• ContentMetadataView: Parse enableTruncation (#863) (0a3104b)
• getSearchSuggestions: Add optional pq param for better suggestions (c61db19)
• Innertube: Add getAttestationChallenge (#869) (33c27dd)
• Innertube: Add ability to get individual community posts and community post comments (#861) (360b29e)
• LiveChatPaidMessage: Parse headerOverlayImage and lowerBumper (#851) (ef37aa0)
• Music: Add continuation support for "Up next" tab in TrackInfo (#770) (2913d5f)
• PageHeaderView: Parse heroImage (a602a31)
• Parser: Add AvatarStackView (c631022)
• Parser: Add HowThisWasMadeSectionView node (5da8a66)
• parser: Add ReplaceLiveChatAction (#847) (342fdd1)
• Parser: Implement utility class to parse rendererContext (3a11b99)
• parser: Parse OpenPopupAction in onResponseReceivedEndpoints arrays (45b7342)
• Parser: Parse YpcTrailer in VideoInfo (#842) (c0043d0)
• parser: Update Button (#857) (5f899fc)
• parser: Update LiveChatPaidMessage (#846) (73362c6)
• parser: Update LiveChatPaidSticker (#849) (3c28c0d)
• parser: Update LiveChatTextMessage (#864) (9025122)
• parser: Update LiveChatTickerPaidMessageItem (#845) (29e8d30)
• parser: Update LiveChatTickerPaidStickerItem (#848) (5f83a74)
• parser: Update LiveChatViewerEngagementMessage (#856) (b4a947a)
• Playlists: Implement addToLibrary and removeFromLibrary (#844) (48460e4)
• RichGrid: Parse targetId (e571ee2)
• Session: Allow using a fixed user agent for InnerTube requests (#876) (4d36655)
• SubscribeButton: Add unsubscribe_text (75b8964)
• ToggleButtonView: Add is_toggled (88af6d8)

Bug Fixes

• ButtonCardView: Correct typo (#855) (6536801)
• DescriptionPreviewView: Parsing errors when certain fields are missing (c2dd803)
• getSearchSuggestions: Allow empty queries (523700b)
• LiveChatTextMessage: Make some fields optional (#877) (a035b71)
• sendMessage: Handle RunAttestationCommand in response actions (#859) (826a954)
• Text#fromAttributed: Fix StyleRun assuming that the startIndex and length always exist (#862) (732a30c)
• Text#toHTML: Return empty string if the text is undefined (f3c777b)
• TextRun: Add img element only if an URL is available (913dcc7)
• toDash: Fix default audio stream for dubbed movie trailers (#858) (0054690)

Performance Improvements

• constants: Move the client name IDs into their own CLIENT_NAME_IDS object (#875) (06887e9)
• Optimise DASH manifest generation (#870) (1a3d663)

Code Refactoring

• Remove web.bundle.min (e54e499)