Documentation Index
Fetch the complete documentation index at: https://mintlify.com/faraasaaay/innertube-v2/llms.txt
Use this file to discover all available pages before exploring further.
Page classes are the structured data objects returned by YouTube browse and search methods. Each page class corresponds to a particular endpoint and bundles together the primary content, related metadata, and continuation tokens needed for pagination.
AlbumPage
Returned by YouTube.album(). Contains the full album with all its tracks.
| Field | Type | Description |
|---|
album | AlbumItem | The album metadata (title, artists, year, thumbnail) |
songs | List<SongItem> | Ordered list of tracks on this album |
otherVersions | List<AlbumItem> | Other versions of this album (e.g. deluxe, explicit, remaster) |
releasesForYou | List<AlbumItem> | Personalized related album suggestions (may be empty) |
description | String? | Plain-text album description |
descriptionRuns | List<Run>? | Structured rich-text runs for the description (with links) |
ArtistPage
Returned by YouTube.artist(). Contains the artist overview with all content sections.
| Field | Type | Description |
|---|
artist | ArtistItem | The artist metadata (name, thumbnail, channel ID) |
sections | List<ArtistSection> | Content carousels and shelves on the artist page |
description | String? | Plain-text artist biography |
subscriberCountText | String? | Formatted subscriber count (e.g. "1.2M subscribers") |
monthlyListenerCount | String? | Monthly listener count string, if available |
descriptionRuns | List<Run>? | Structured rich-text runs for the biography |
ArtistSection
A single content section within an ArtistPage (e.g. “Songs”, “Albums”, “Singles”).
| Field | Type | Description |
|---|
title | String | Section heading label |
items | List<YTItem> | Items in this section — may be SongItem, AlbumItem, PlaylistItem, or ArtistItem |
moreEndpoint | BrowseEndpoint? | Endpoint to load a full listing of all items in this section, or null if all items are already shown |
PlaylistPage
Returned by YouTube.playlist(). Contains the playlist metadata and its initial batch of songs.
| Field | Type | Description |
|---|
playlist | PlaylistItem | Playlist metadata (title, author, thumbnail) |
songs | List<SongItem> | First batch of songs in the playlist |
songsContinuation | String? | Continuation token to load additional songs |
continuation | String? | Continuation token for the overall page |
related | List<YTItem>? | Related items shown at the bottom of the playlist page |
PlaylistContinuationPage
Returned by YouTube.playlistContinuation(). Contains only the next batch of songs.
| Field | Type | Description |
|---|
songs | List<SongItem> | Next batch of songs |
continuation | String? | Token for the following page, or null if this is the last page |
ArtistItemsPage
Returned by YouTube.artistItems(). Contains a full listing of one artist section (e.g. all albums).
| Field | Type | Description |
|---|
title | String | Section title (e.g. "Albums") |
items | List<YTItem> | All items in the section |
continuation | String? | Continuation token for more items, if any |
ArtistItemsContinuationPage
Returned when paginating an artist items listing.
| Field | Type | Description |
|---|
items | List<YTItem> | Next batch of items |
continuation | String? | Token for the following page, or null if exhausted |
NextResult
Returned by YouTube.next(). Contains the “Up Next” queue panel for a playing track.
| Field | Type | Description |
|---|
title | String? | Panel title (e.g. playlist or radio name) |
items | List<SongItem> | Tracks in the queue panel |
currentIndex | Int? | Zero-based index of the currently playing track within items |
lyricsEndpoint | BrowseEndpoint? | Endpoint for fetching lyrics via YouTube.lyrics() |
relatedEndpoint | BrowseEndpoint? | Endpoint for fetching related content via YouTube.relatedSongs() |
continuation | String? | Token to load more queue items |
endpoint | WatchEndpoint | The watch endpoint representing the current or continuation position |
SearchResult
Returned by YouTube.search() and YouTube.searchContinuation().
| Field | Type | Description |
|---|
items | List<YTItem> | Mixed list of SongItem, AlbumItem, ArtistItem, and PlaylistItem results |
continuation | String? | Token to load the next page of results |
SearchSuggestions
Returned by YouTube.searchSuggestions(). Contains type-ahead suggestions.
| Field | Type | Description |
|---|
queries | List<String> | Autocomplete query strings |
recommendedItems | List<YTItem> | Recommended content items associated with the search query |
SearchSummaryPage
Returned by YouTube.searchSummary(). Contains grouped results across multiple content type categories.
| Field | Type | Description |
|---|
summaries | List<SearchSummary> | One entry per category (e.g. “Top result”, “Songs”, “Albums”) |
SearchSummary
| Field | Type | Description |
|---|
title | String | Category heading (e.g. "Songs", "Artists") |
items | List<YTItem> | Items in this category |
HomePage
Returned by YouTube.home(). Contains the YouTube Music home feed.
| Field | Type | Description |
|---|
chips | List<Chip>? | Filter chips at the top of the home feed (e.g. “Mixed for you”, “New releases”) |
sections | List<Section> | Content carousels on the home page |
continuation | String? | Token to load more sections |
HomePage.Chip
| Field | Type | Description |
|---|
title | String | Chip label text |
endpoint | BrowseEndpoint? | Endpoint to navigate to this filter’s content |
deselectEndPoint | BrowseEndpoint? | Endpoint to deselect this chip and return to unfiltered home |
HomePage.Section
| Field | Type | Description |
|---|
title | String | Section heading |
label | String? | Strapline label (e.g. artist or curator name) |
thumbnail | String? | Section header thumbnail, if present |
endpoint | BrowseEndpoint? | ”See more” browse endpoint for the section |
items | List<YTItem> | Content items in the carousel |
HomePage also has filterExplicit() and filterVideoSongs() methods that mirror the List<YTItem> extensions — they apply the filter to every section’s item list at once.
ExplorePage
Returned by YouTube.explore(). Contains the Explore tab content.
| Field | Type | Description |
|---|
newReleaseAlbums | List<AlbumItem> | Newly released albums |
moodAndGenres | List<MoodAndGenres.Item> | Mood and genre category links |
ChartsPage
Returned by YouTube.getChartsPage(). Contains music chart rankings.
| Field | Type | Description |
|---|
sections | List<ChartSection> | Chart sections (e.g. Trending, Top Songs) |
continuation | String? | Token to load more chart data |
ChartsPage.ChartSection
| Field | Type | Description |
|---|
title | String | Chart section title (e.g. "Trending") |
items | List<YTItem> | Ranked items — usually SongItem with chartPosition set |
chartType | ChartType | Enum identifying the type of chart |
ChartType
| Value | Description |
|---|
TRENDING | Currently trending tracks |
TOP | All-time or weekly top tracks |
GENRE | Genre-specific chart |
NEW_RELEASES | Recently released tracks |
LibraryPage
Returned by YouTube.library(). Contains the user’s saved library items.
| Field | Type | Description |
|---|
items | List<YTItem> | Library items (playlists, albums, artists) |
continuation | String? | Token to load more library items |
LibraryContinuationPage
Returned when paginating the library.
| Field | Type | Description |
|---|
items | List<YTItem> | Next batch of library items |
continuation | String? | Token for the following page, or null |
HistoryPage
Returned by YouTube.musicHistory(). Contains the user’s listening history grouped by time period.
| Field | Type | Description |
|---|
sections | List<HistorySection>? | History sections grouped by date (e.g. “Today”, “Yesterday”) |
RelatedPage
Returned by YouTube.relatedSongs(). Contains content related to a currently playing track.
| Field | Type | Description |
|---|
songs | List<SongItem> | Related tracks |
albums | List<AlbumItem> | Related albums |
artists | List<ArtistItem> | Related artists |
playlists | List<PlaylistItem> | Related playlists |
BrowseResult
Returned by YouTube.browse(). A generic container for arbitrary InnerTube browse responses.
| Field | Type | Description |
|---|
title | String? | Page title, if present |
items | List<BrowseResult.Item> | Grouped sections of content |
BrowseResult.Item
| Field | Type | Description |
|---|
title | String? | Section heading |
items | List<YTItem> | Items in this section |