Downloads a given video. If all you need the direct download link, see getStreamingData. If you wish to retrieve the video info too, have a look at getBasicInfo or getInfo.

Parameters

• video_id: string

The video id.

• options?: DownloadOptions

Download options.

Returns

Promise<ReadableStream<Uint8Array>>

Defined in

src/Innertube.ts:423

getBasicInfo()

getBasicInfo(video_id, client?): Promise<VideoInfo>

Parameters

• video_id: string

• client?: InnerTubeClient

Returns

Promise<VideoInfo>

Defined in

src/Innertube.ts:107

getChannel()

getChannel(id): Promise<Channel>

Parameters

• id: string

Returns

Promise<Channel>

Defined in

src/Innertube.ts:331

getChannelsFeed()

getChannelsFeed(): Promise<Feed<IBrowseResponse>>

Returns

Promise<Feed<IBrowseResponse>>

Defined in

src/Innertube.ts:324

getComments()

getComments(video_id, sort_by?, comment_id?): Promise<Comments>

Parameters

• video_id: string

• sort_by?: "TOP_COMMENTS" | "NEWEST_FIRST"

• comment_id?: string

Returns

Promise<Comments>

Defined in

src/Innertube.ts:250

getGuide()

getGuide(): Promise<Guide>

Retrieves YouTube's content guide.

Returns

Promise<Guide>

Defined in

src/Innertube.ts:291

getHashtag()

getHashtag(hashtag): Promise<HashtagFeed>

Parameters

• hashtag: string

Returns

Promise<HashtagFeed>

Defined in

src/Innertube.ts:378

getHistory()

getHistory(): Promise<History>

Returns

Promise<History>

Defined in

src/Innertube.ts:303

getHomeFeed()

getHomeFeed(): Promise<HomeFeed>

Returns

Promise<HomeFeed>

Defined in

src/Innertube.ts:281

getInfo()

getInfo(target, client?): Promise<VideoInfo>

Parameters

• target: string | NavigationEndpoint

• client?: InnerTubeClient

Returns

Promise<VideoInfo>

Defined in

src/Innertube.ts:67

getLibrary()

getLibrary(): Promise<Library>

Returns

Promise<Library>

Defined in

src/Innertube.ts:296

getNotifications()

getNotifications(): Promise<NotificationsMenu>

Returns

Promise<NotificationsMenu>

Defined in

src/Innertube.ts:339

getPlaylist()

getPlaylist(id): Promise<Playlist>

Parameters

• id: string

Returns

Promise<Playlist>

Defined in

src/Innertube.ts:364

getPlaylists()

getPlaylists(): Promise<Feed<IBrowseResponse>>

Retrieves the user's playlists.

Returns

Promise<Feed<IBrowseResponse>>

Defined in

src/Innertube.ts:357

getSearchSuggestions()

getSearchSuggestions(query): Promise<string[]>

Parameters

• query: string

Returns

Promise<string[]>

Defined in

src/Innertube.ts:229

getShortsVideoInfo()

getShortsVideoInfo(video_id, client?): Promise<ShortFormVideoInfo>

Parameters

• video_id: string

• client?: InnerTubeClient

Returns

Promise<ShortFormVideoInfo>

Defined in

src/Innertube.ts:124

getStreamingData()

getStreamingData(video_id, options): Promise<Format>

An alternative to download. Returns deciphered streaming data.

If you wish to retrieve the video info too, have a look at getBasicInfo or getInfo.

Parameters

• video_id: string

The video id.

• options: FormatOptions = {}

Format options.

Returns

Promise<Format>

Defined in

src/Innertube.ts:408

getSubscriptionsFeed()

getSubscriptionsFeed(): Promise<Feed<IBrowseResponse>>

Returns

Promise<Feed<IBrowseResponse>>

Defined in

src/Innertube.ts:317

getTrending()

getTrending(): Promise<TabbedFeed<IBrowseResponse>>

Returns

Promise<TabbedFeed<IBrowseResponse>>

Defined in

src/Innertube.ts:310

getUnseenNotificationsCount()

getUnseenNotificationsCount(): Promise<number>

Returns

Promise<number>

Defined in

src/Innertube.ts:348

resolveURL()

resolveURL(url): Promise<NavigationEndpoint>

Resolves the given URL.

Parameters

• url: string

The URL.

Returns

Promise<NavigationEndpoint>

Defined in

src/Innertube.ts:432

search()

search(query, filters): Promise<Search>

Parameters

• query: string

• filters: SearchFilters = {}

Returns

Promise<Search>

Defined in

src/Innertube.ts:155

create()

static create(config): Promise<Innertube>

Parameters

• config: SessionOptions = {}

Returns

Promise<Innertube>

Defined in

src/Innertube.ts:63