Class Client

Typed, async client for the Yandex Music API.

Example

import { Client } from '@dvxch/yandex-music';

const client = await new Client({ token: process.env.YM_TOKEN }).init();
const [track] = await client.tracks(2);
console.log(track?.title);

const [info] = await track!.getDownloadInfo();
await info.download('track.mp3');

Remarks

Construct with an OAuth token and call Client.init once to load account information used by some endpoints. Supported response languages are en, uz, uk, us, ru, kk and hy.

Hierarchy

ComposedClient
- Client

Index

Constructors

constructor

new Client(options?: ClientOptions): Client
Parameters
- options: ClientOptions = {}
  Client configuration (token, base URL, language, ...).
Returns Client
Overrides ComposedClient.constructor
- Defined in src/client.ts:94

Properties

`Optional`accountUid

accountUid?: number

Account uid, populated by Client.init.

baseUrl

baseUrl: string

API origin used to build request URLs.

device

device: string = DEFAULT_DEVICE

Device descriptor used for queue requests.

language

language: string

Response language code.

`Optional`me

me?: Status

Account status, populated by Client.init.

`Optional`onUnknownField

onUnknownField?: UnknownFieldReporter

Optional hook for unmapped-field reports; see ClientOptions.onUnknownField.

reportUnknownFields

reportUnknownFields: boolean

Whether unknown-field warnings are enabled.

`Readonly`request

request: Request

The HTTP transport.

`Optional`token

token?: string

OAuth token used to authenticate requests, if any.

Methods

accountExperiments

accountExperiments(): Promise<Experiments | null>
Fetch the account's experiment buckets.

Returns Promise<Experiments | null>
The experiments, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.accountExperiments
- Defined in src/methods/account.ts:115

accountExperimentsDetails

accountExperimentsDetails(): Promise<ExperimentsDetails | null>
Fetch detailed experiment configuration for the account.

Returns Promise<ExperimentsDetails | null>
The detailed experiments, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.accountExperimentsDetails
- Defined in src/methods/account.ts:126

accountSettings

accountSettings(): Promise<UserSettings | null>
Fetch the current user's settings.

Returns Promise<UserSettings | null>
The user settings, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.accountSettings
- Defined in src/methods/account.ts:64

accountSettingsSet

accountSettingsSet(
paramOrData: string | Record<string, string | number | boolean>,
value?: string | number | boolean,
): Promise<UserSettings | null>
Change one or many of the current user's settings.
Parameters
- paramOrData: string | Record<string, string | number | boolean>
  A single setting name, or a map of setting names to values.
- Optionalvalue: string | number | boolean
  The value, when paramOrData is a single setting name.
Returns Promise<UserSettings | null>
The updated user settings, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.accountSettingsSet
- Defined in src/methods/account.ts:77

accountStatus

accountStatus(): Promise<Status | null>
Fetch the status of the authenticated account.

Returns Promise<Status | null>
The account status, or null when the token is invalid.

Throws
On any transport or API error.
Inherited from ComposedClient.accountStatus
- Defined in src/methods/account.ts:52

afterTrack

afterTrack(
    nextTrackId: string | number,
    contextItem: string,
    prevTrackId?: string | number,
    context?: string,
    types?: string,
    from?: string,
): Promise<ShotEvent | null>
Fetch an ad or an Alice shot to play after a track.
Parameters
- nextTrackId: string | number
  The upcoming track id.
- contextItem: string
  Context identifier (for playlists, ownerId:playlistId).
- OptionalprevTrackId: string | number
  The previous track id (optional for Alice shots).
- context: string = 'playlist'
  Context kind. Defaults to playlist.
- types: string = 'shot'
  What to return after the track. Defaults to shot.
- from: string = 'mobile-landing-origin-default'
  Where the context was entered from.
Returns Promise<ShotEvent | null>
The shot event, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.afterTrack
- Defined in src/methods/tracks.ts:244

albums

albums(albumIds: string | number | (string | number)[]): Promise<Album[]>
Fetch one or many albums by id (without their track lists).
Parameters
- albumIds: string | number | (string | number)[]
  A single id or a list of ids.
Returns Promise<Album[]>
The requested albums.

Throws
On any transport or API error.
Inherited from ComposedClient.albums
- Defined in src/methods/albums.ts:28

albumsDisclaimer

albumsDisclaimer(albumId: string | number): Promise<Disclaimer | null>
Fetch the disclaimer of an album.
Parameters
- albumId: string | number
  The album id.
Returns Promise<Disclaimer | null>
The disclaimer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.albumsDisclaimer
- Defined in src/methods/disclaimers.ts:51

albumsSimilarEntities

albumsSimilarEntities(
albumId: string | number,
): Promise<AlbumSimilarEntities | null>
Fetch entities similar to an album.
Parameters
- albumId: string | number
  The album id.
Returns Promise<AlbumSimilarEntities | null>
The similar entities, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.albumsSimilarEntities
- Defined in src/methods/albums.ts:52

albumsTrailer

albumsTrailer(albumId: string | number): Promise<AlbumTrailer | null>
Fetch the trailer of an album.
Parameters
- albumId: string | number
  The album id.
Returns Promise<AlbumTrailer | null>
The album trailer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.albumsTrailer
- Defined in src/methods/albums.ts:65

albumsWithTracks

albumsWithTracks(albumId: string | number): Promise<Album | null>
Fetch a single album together with all of its tracks (grouped by volume).
Parameters
- albumId: string | number
  The album id.
Returns Promise<Album | null>
The album with its volumes, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.albumsWithTracks
- Defined in src/methods/albums.ts:39

artists

artists(artistIds: string | number | (string | number)[]): Promise<Artist[]>
Fetch one or many artists by id.
Parameters
- artistIds: string | number | (string | number)[]
  A single id or a list of ids.
Returns Promise<Artist[]>
The requested artists.

Throws
On any transport or API error.
Inherited from ComposedClient.artists
- Defined in src/methods/artists.ts:46

artistsAbout

artistsAbout(artistId: string | number): Promise<ArtistAbout | null>
Fetch the "about" block of an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistAbout | null>
The about block, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsAbout
- Defined in src/methods/artists.ts:239

artistsAlsoAlbums

artistsAlsoAlbums(
    artistId: string | number,
    page?: number,
    pageSize?: number,
    sortBy?: ArtistAlbumsSortBy,
): Promise<ArtistAlbums | null>
Fetch a page of compilations and albums the artist also appears on.
Parameters
- artistId: string | number
  The artist id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Albums per page. Defaults to 20.
- sortBy: ArtistAlbumsSortBy = 'year'
  Sort key. Defaults to 'year'.
Returns Promise<ArtistAlbums | null>
The page of albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsAlsoAlbums
- Defined in src/methods/artists.ts:109

artistsBriefInfo

artistsBriefInfo(artistId: string | number): Promise<BriefInfo | null>
Fetch aggregate information about an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<BriefInfo | null>
The brief info, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsBriefInfo
- Defined in src/methods/artists.ts:57

artistsClips

artistsClips(artistId: string | number): Promise<ArtistClips | null>
Fetch the artist-clips block of an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistClips | null>
The clips block, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsClips
- Defined in src/methods/artists.ts:252

artistsConcerts

artistsConcerts(artistId: string | number): Promise<ArtistConcerts | null>
Fetch an artist's upcoming concerts.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistConcerts | null>
The artist's concerts, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsConcerts
- Defined in src/methods/concerts.ts:34

artistsDirectAlbums

artistsDirectAlbums(
    artistId: string | number,
    page?: number,
    pageSize?: number,
    sortBy?: ArtistAlbumsSortBy,
): Promise<ArtistAlbums | null>
Fetch a page of albums where the artist is the primary author.
Parameters
- artistId: string | number
  The artist id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Albums per page. Defaults to 20.
- sortBy: ArtistAlbumsSortBy = 'year'
  Sort key. Defaults to 'year'.
Returns Promise<ArtistAlbums | null>
The page of albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsDirectAlbums
- Defined in src/methods/artists.ts:88

artistsDisclaimer

artistsDisclaimer(artistId: string | number): Promise<Disclaimer | null>
Fetch the disclaimer of an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<Disclaimer | null>
The disclaimer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsDisclaimer
- Defined in src/methods/disclaimers.ts:63

artistsDiscographyAlbums

artistsDiscographyAlbums(
    artistId: string | number,
    page?: number,
    pageSize?: number,
    sortBy?: ArtistAlbumsSortBy,
): Promise<ArtistAlbums | null>
Fetch a page of the artist's discography.
Parameters
- artistId: string | number
  The artist id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Albums per page. Defaults to 20.
- sortBy: ArtistAlbumsSortBy = 'year'
  Sort key. Defaults to 'year'.
Returns Promise<ArtistAlbums | null>
The page of albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsDiscographyAlbums
- Defined in src/methods/artists.ts:130

artistsDonation

artistsDonation(artistId: string | number): Promise<ArtistDonations | null>
Fetch the artist-donation block of an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistDonations | null>
The donation block, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsDonation
- Defined in src/methods/artists.ts:265

artistsInfo

artistsInfo(artistId: string | number): Promise<ArtistInfo | null>
Fetch detailed information about an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistInfo | null>
The artist info, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsInfo
- Defined in src/methods/artists.ts:226

artistsLinks

artistsLinks(artistId: string | number): Promise<ArtistLinks | null>
Fetch the external links shown on an artist's page.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistLinks | null>
The links, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsLinks
- Defined in src/methods/artists.ts:182

artistsSafeDirectAlbums

artistsSafeDirectAlbums(
    artistId: string | number,
    sortBy?: ArtistAlbumsSortBy,
    sortOrder?: SortOrder,
    limit?: number,
): Promise<ArtistAlbums | null>
Fetch the artist's "safe" direct albums (no explicit content).
Parameters
- artistId: string | number
  The artist id.
- sortBy: ArtistAlbumsSortBy = 'year'
  Sort key. Defaults to 'year'.
- sortOrder: SortOrder = 'desc'
  Sort direction. Defaults to 'desc'.
- limit: number = 20
  Maximum number of albums. Defaults to 20.
Returns Promise<ArtistAlbums | null>
The albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsSafeDirectAlbums
- Defined in src/methods/artists.ts:151

artistsSimilar

artistsSimilar(artistId: string | number): Promise<ArtistSimilar | null>
Fetch artists similar to the given one.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistSimilar | null>
The similar artists, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsSimilar
- Defined in src/methods/artists.ts:169

artistsSkeleton

artistsSkeleton(
artistId: string | number,
skeletonId: string,
): Promise<ArtistSkeleton | null>
Fetch a skeleton (page layout) of an artist.
Parameters
- artistId: string | number
  The artist id.
- skeletonId: string
  The skeleton id.
Returns Promise<ArtistSkeleton | null>
The skeleton, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsSkeleton
- Defined in src/methods/artists.ts:279

artistsTrackIds

artistsTrackIds(
    artistId: string | number,
    page?: number,
    pageSize?: number,
): Promise<(string | number)[]>
Fetch a page of the artist's track ids.
Parameters
- artistId: string | number
  The artist id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Ids per page. Defaults to 20.
Returns Promise<(string | number)[]>
The list of track ids, or an empty array.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsTrackIds
- Defined in src/methods/artists.ts:210

artistsTracks

artistsTracks(
    artistId: string | number,
    page?: number,
    pageSize?: number,
): Promise<ArtistTracks | null>
Fetch a page of an artist's tracks.
Parameters
- artistId: string | number
  The artist id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Tracks per page. Defaults to 20.
Returns Promise<ArtistTracks | null>
The page of tracks, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsTracks
- Defined in src/methods/artists.ts:72

artistsTrailer

artistsTrailer(artistId: string | number): Promise<ArtistTrailer | null>
Fetch the trailer of an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<ArtistTrailer | null>
The trailer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.artistsTrailer
- Defined in src/methods/artists.ts:195

chart

chart(chartOption?: string): Promise<ChartInfo | null>
Fetch a chart (/landing3/chart).
Parameters
- chartOption: string = ''
  Optional chart option (for example a country code).
Returns Promise<ChartInfo | null>
The chart, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.chart
- Defined in src/methods/landing.ts:48

clips

clips(clipIds: string | number | (string | number)[]): Promise<Clip[]>
Fetch one or many clips by id.
Parameters
- clipIds: string | number | (string | number)[]
  A single clip id or a list of ids.
Returns Promise<Clip[]>
The requested clips.

Throws
On any transport or API error.
Inherited from ComposedClient.clips
- Defined in src/methods/clips.ts:28

clipsCredits

clipsCredits(clipId: string | number): Promise<Credits | null>
Fetch the production credits of a clip.
Parameters
- clipId: string | number
  The clip id.
Returns Promise<Credits | null>
The credits, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.clipsCredits
- Defined in src/methods/credits.ts:39

clipsDisclaimer

clipsDisclaimer(clipId: string | number): Promise<Disclaimer | null>
Fetch the disclaimer of a clip.
Parameters
- clipId: string | number
  The clip id.
Returns Promise<Disclaimer | null>
The disclaimer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.clipsDisclaimer
- Defined in src/methods/disclaimers.ts:39

clipsWillLike

clipsWillLike(page?: number, pageSize?: number): Promise<ClipsWillLike | null>
Fetch a recommended page of clips.
Parameters
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 50
  Clips per page. Defaults to 50.
Returns Promise<ClipsWillLike | null>
The recommended clips, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.clipsWillLike
- Defined in src/methods/clips.ts:42

concertInfo

concertInfo(concertId: string | number): Promise<ConcertInfo | null>
Fetch detailed information about a concert.
Parameters
- concertId: string | number
  The concert id.
Returns Promise<ConcertInfo | null>
The concert info, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.concertInfo
- Defined in src/methods/concerts.ts:46

concertsFeed

concertsFeed(locations?: (string | number)[]): Promise<ConcertFeed | null>
Fetch the concert feed, optionally filtered by location.
Parameters
- Optionallocations: (string | number)[]
  Location ids to filter by.
Returns Promise<ConcertFeed | null>
The concert feed, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.concertsFeed
- Defined in src/methods/concerts.ts:71

concertSkeleton

concertSkeleton(
concertId: string | number,
skeletonId?: string,
): Promise<ConcertSkeleton | null>
Fetch the skeleton (render scaffold) of a concert page.
Parameters
- concertId: string | number
  The concert id.
- skeletonId: string = 'concert_page'
  The skeleton id. Defaults to 'concert_page'.
Returns Promise<ConcertSkeleton | null>
The skeleton, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.concertSkeleton
- Defined in src/methods/concerts.ts:59

concertsLocations

concertsLocations(): Promise<ConcertLocations | null>
Fetch the available concert locations.

Returns Promise<ConcertLocations | null>
The locations, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.concertsLocations
- Defined in src/methods/concerts.ts:83

concertsTabConfig

concertsTabConfig(): Promise<ConcertTabConfig | null>
Fetch the concert tab configuration.

Returns Promise<ConcertTabConfig | null>
The tab config, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.concertsTabConfig
- Defined in src/methods/concerts.ts:94

consumePromoCode

consumePromoCode(
code: string,
language?: string,
): Promise<PromoCodeStatus | null>
Activate a promo code.
Parameters
- code: string
  The promo code.
- Optionallanguage: string
  Response language. Defaults to the client language.
Returns Promise<PromoCodeStatus | null>
The activation result, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.consumePromoCode
- Defined in src/methods/account.ts:139

deviceAuth

deviceAuth(
onCode: OnCodeCallback,
options?: DeviceAuthOptions,
): Promise<OAuthToken>
Run the full blocking device flow: request a code, surface it through onCode, then poll until the user confirms and a token is returned.
Parameters
- onCode: OnCodeCallback
  Callback receiving the DeviceCode to show the user.
- options: DeviceAuthOptions = {}
  Polling/timeout configuration and credential overrides.
Returns Promise<OAuthToken>
The issued OAuthToken.

Throws
On timeout, cancellation or OAuth error.

Throws
On any transport error.
Inherited from ComposedClient.deviceAuth
- Defined in src/methods/deviceAuth.ts:166

feed

feed(): Promise<Feed | null>
Fetch the personalised feed (legacy /feed endpoint).

Returns Promise<Feed | null>
The feed, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.feed
- Defined in src/methods/landing.ts:106

feedWizardIsPassed

feedWizardIsPassed(): Promise<boolean>
Check whether the feed onboarding wizard has been completed.

Returns Promise<boolean>
true when the wizard has been passed.

Throws
On any transport or API error.
Inherited from ComposedClient.feedWizardIsPassed
- Defined in src/methods/landing.ts:117

genres

genres(): Promise<Genre[]>
Fetch the genre tree.

Returns Promise<Genre[]>
The list of top-level genres (each with nested sub-genres).

Throws
On any transport or API error.
Inherited from ComposedClient.genres
- Defined in src/methods/landing.ts:95

init

init(): Promise<Client>
Initialize the client by loading account status.

Populates ClientBase.me and ClientBase.accountUid, which a number of other endpoints rely on. Call this once after construction.

Returns Promise<Client>
The same client, for chaining.

Throws
On any transport or API error.
Inherited from ComposedClient.init
- Defined in src/methods/account.ts:37

label

label(labelId: string | number): Promise<Label | null>
Fetch a record label by id.
Parameters
- labelId: string | number
  The label id.
Returns Promise<Label | null>
The label, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.label
- Defined in src/methods/labels.ts:29

labelAlbums

labelAlbums(
    labelId: string | number,
    page?: number,
    pageSize?: number,
    sortBy?: ArtistAlbumsSortBy,
    sortOrder?: SortOrder,
): Promise<LabelAlbums | null>
Fetch a page of a label's albums.
Parameters
- labelId: string | number
  The label id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 100
  Albums per page. Defaults to 100.
- OptionalsortBy: ArtistAlbumsSortBy
  Sort key.
- OptionalsortOrder: SortOrder
  Sort direction.
Returns Promise<LabelAlbums | null>
The page of albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.labelAlbums
- Defined in src/methods/labels.ts:45

labelArtists

labelArtists(
    labelId: string | number,
    page?: number,
    pageSize?: number,
): Promise<LabelArtists | null>
Fetch a page of a label's artists.
Parameters
- labelId: string | number
  The label id.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 100
  Artists per page. Defaults to 100.
Returns Promise<LabelArtists | null>
The page of artists, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.labelArtists
- Defined in src/methods/labels.ts:70

landing

landing(blocks: string | string[]): Promise<Landing | null>
Fetch one or more landing blocks (/landing3).
Parameters
- blocks: string | string[]
  A block name or list of block names (for example personalplaylists, chart).
Returns Promise<Landing | null>
The landing page, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.landing
- Defined in src/methods/landing.ts:35

metatag

metatag(metatagId: string, options?: MetatagOptions): Promise<Metatag | null>
Fetch aggregate information about a metatag.
Parameters
- metatagId: string
  The metatag id.
- options: MetatagOptions = {}
  Optional per-section counts and sort keys.
Returns Promise<Metatag | null>
The metatag, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.metatag
- Defined in src/methods/metatags.ts:61

metatagAlbums

metatagAlbums(
    metatagId: string,
    options?: {
        limit?: number;
        offset?: number;
        period?: string;
        sortBy?: string;
    },
): Promise<MetatagAlbums | null>
Fetch a page of a metatag's albums.
Parameters
- metatagId: string
  The metatag id.
- options: { limit?: number; offset?: number; period?: string; sortBy?: string } = {}
  Optional period, sort key and pagination.
Returns Promise<MetatagAlbums | null>
The page of albums, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.metatagAlbums
- Defined in src/methods/metatags.ts:74

metatagArtists

metatagArtists(
    metatagId: string,
    options?: {
        limit?: number;
        offset?: number;
        period?: string;
        sortBy?: string;
        tracksPerArtist?: number;
    },
): Promise<MetatagArtists | null>
Fetch a page of a metatag's artists.
Parameters
- metatagId: string
  The metatag id.
- options: {
      limit?: number;
      offset?: number;
      period?: string;
      sortBy?: string;
      tracksPerArtist?: number;
  } = {}
  Period (required by the API, defaults to week), sort key, pagination and tracks-per-artist.
Returns Promise<MetatagArtists | null>
The page of artists, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.metatagArtists
- Defined in src/methods/metatags.ts:93

metatagPlaylists

metatagPlaylists(
    metatagId: string,
    options?: {
        limit?: number;
        offset?: number;
        sortBy?: string;
        withLikesCount?: boolean;
    },
): Promise<MetatagPlaylists | null>
Fetch a page of a metatag's playlists.
Parameters
- metatagId: string
  The metatag id.
- options: { limit?: number; offset?: number; sortBy?: string; withLikesCount?: boolean } = {}
  Optional sort key, pagination and likes-count flag.
Returns Promise<MetatagPlaylists | null>
The page of playlists, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.metatagPlaylists
- Defined in src/methods/metatags.ts:116

metatags

metatags(): Promise<Metatags | null>
Fetch the metatag navigation (moods, activities, genres, epochs).

Returns Promise<Metatags | null>
The metatag navigation, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.metatags
- Defined in src/methods/metatags.ts:48

musicHistory

musicHistory(fullModelsCount?: number): Promise<MusicHistory | null>
Fetch the user's listening history grouped by day.
Parameters
- fullModelsCount: number = 0
  How many items to return with their full models inlined. Defaults to 0.
Returns Promise<MusicHistory | null>
The listening history, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.musicHistory
- Defined in src/methods/musicHistory.ts:62

musicHistoryItems

musicHistoryItems(
query: MusicHistoryItemsQuery,
): Promise<MusicHistoryItems | null>
Fetch history items for a specific set of entities.
Parameters
- query: MusicHistoryItemsQuery
  The entity ids to resolve.
Returns Promise<MusicHistoryItems | null>
The resolved history items, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.musicHistoryItems
- Defined in src/methods/musicHistory.ts:75

newPlaylists

newPlaylists(): Promise<LandingList | null>
Fetch the "new playlists" landing list.

Returns Promise<LandingList | null>
The list, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.newPlaylists
- Defined in src/methods/landing.ts:73

newReleases

newReleases(): Promise<LandingList | null>
Fetch the "new releases" landing list.

Returns Promise<LandingList | null>
The list, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.newReleases
- Defined in src/methods/landing.ts:62

permissionAlerts

permissionAlerts(): Promise<PermissionAlerts | null>
Fetch permission alert messages.

Returns Promise<PermissionAlerts | null>
The alerts, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.permissionAlerts
- Defined in src/methods/account.ts:104

pinAlbum

pinAlbum(albumId: string | number): Promise<Pin | null>
Pin an album.
Parameters
- albumId: string | number
  The album id.
Returns Promise<Pin | null>
The created pin, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.pinAlbum
- Defined in src/methods/pins.ts:38

pinArtist

pinArtist(artistId: string | number): Promise<Pin | null>
Pin an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<Pin | null>
The created pin, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.pinArtist
- Defined in src/methods/pins.ts:62

pinPlaylist

pinPlaylist(uid: string | number, kind: string | number): Promise<Pin | null>
Pin a playlist.
Parameters
- uid: string | number
  The playlist owner uid.
- kind: string | number
  The playlist kind.
Returns Promise<Pin | null>
The created pin, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.pinPlaylist
- Defined in src/methods/pins.ts:87

pins

pins(): Promise<PinsList | null>
Fetch the user's pinned items.

Returns Promise<PinsList | null>
The pinned items, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.pins
- Defined in src/methods/pins.ts:26

pinWave

pinWave(seeds: string): Promise<Pin | null>
Pin a wave (radio seed, for example artist:12345).
Parameters
- seeds: string
  The wave seed identifier.
Returns Promise<Pin | null>
The created pin, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.pinWave
- Defined in src/methods/pins.ts:112

playAudio

playAudio(options: PlayAudioOptions): Promise<boolean>
Report the current playback state of a track.
Parameters
- options: PlayAudioOptions
  The playback report.
Returns Promise<boolean>
Whether the report was accepted.

Throws
On any transport or API error.
Inherited from ComposedClient.playAudio
- Defined in src/methods/tracks.ts:211

playlist

playlist(playlistUuid: string): Promise<Playlist | null>
Fetch a playlist by its stable UUID.
Parameters
- playlistUuid: string
  The playlist UUID.
Returns Promise<Playlist | null>
The Playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.playlist
- Defined in src/methods/playlists.ts:288

playlists

playlists(playlistIds: string | string[]): Promise<PlaylistsList | null>
Fetch a list of playlists by their uid:kind ids.
Parameters
- playlistIds: string | string[]
  A single id or a list of ids in uid:kind form.
Returns Promise<PlaylistsList | null>
The playlists, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.playlists
- Defined in src/methods/playlists.ts:314

playlistsCollectiveJoin

playlistsCollectiveJoin(userId: number, token: string): Promise<boolean>
Join a collaborative playlist as a co-author.
Parameters
- userId: number
  The numeric id of the playlist owner.
- token: string
  The join token (from the "add co-author" link).
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.playlistsCollectiveJoin
- Defined in src/methods/playlists.ts:260

playlistSimilarEntities

playlistSimilarEntities(
playlistUuid: string,
): Promise<PlaylistSimilarEntities | null>
Fetch entities similar to a playlist.
Parameters
- playlistUuid: string
  The playlist UUID.
Returns Promise<PlaylistSimilarEntities | null>
The similar entities, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.playlistSimilarEntities
- Defined in src/methods/playlists.ts:301

playlistsList

playlistsList(
playlistIds: string | number | (string | number)[],
): Promise<Playlist[]>
Fetch a short-form list of playlists by their uid:kind ids.
Parameters
- playlistIds: string | number | (string | number)[]
  A single id or a list of ids in uid:kind form.
Returns Promise<Playlist[]>
The playlists.

Remarks
The returned playlists do not carry their track lists; use usersPlaylists to obtain a playlist with tracks populated.

Throws
On any transport or API error.
Inherited from ComposedClient.playlistsList
- Defined in src/methods/playlists.ts:332

playlistsPersonal

playlistsPersonal(playlistId: string): Promise<GeneratedPlaylist | null>
Fetch a personal (auto-generated) playlist.
Parameters
- playlistId: string
  The personal-playlist id.
Returns Promise<GeneratedPlaylist | null>
The generated playlist, or null.

Remarks
Known ids: daily, missedLikes, recentTracks, neverHeard, podcasts, origin.

Throws
On any transport or API error.
Inherited from ComposedClient.playlistsPersonal
- Defined in src/methods/playlists.ts:347

podcasts

podcasts(): Promise<LandingList | null>
Fetch the podcasts landing list.

Returns Promise<LandingList | null>
The list, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.podcasts
- Defined in src/methods/landing.ts:84

pollDeviceToken

pollDeviceToken(
    deviceCode: string,
    clientId?: string,
    clientSecret?: string,
): Promise<OAuthToken | null>
Poll once for the token of a pending device authorization.
Parameters
- deviceCode: string
  The deviceCode from requestDeviceCode.
- OptionalclientId: string
  OAuth client id.
- OptionalclientSecret: string
  OAuth client secret.
Returns Promise<OAuthToken | null>
The token, or null while the user has not yet confirmed.

Throws
On any OAuth error other than authorization_pending.

Throws
On any transport error.
Inherited from ComposedClient.pollDeviceToken
- Defined in src/methods/deviceAuth.ts:97

queue

queue(queueId: string): Promise<Queue | null>
Fetch a single queue by id.
Parameters
- queueId: string
  The queue id.
Returns Promise<Queue | null>
The queue, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.queue
- Defined in src/methods/queue.ts:49

queueCreate

queueCreate(queue: string | JSONObject, device?: string): Promise<string | null>
Create a new playback queue.
Parameters
- queue: string | JSONObject
  The queue, as a JSON object or a pre-serialized JSON string.
- Optionaldevice: string
  Device descriptor. Defaults to the client device.
Returns Promise<string | null>
The id of the created queue, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.queueCreate
- Defined in src/methods/queue.ts:78

queuesList

queuesList(device?: string): Promise<QueueItem[]>
Fetch the list of the user's queues.
Parameters
- Optionaldevice: string
  Device descriptor. Defaults to the client device.
Returns Promise<QueueItem[]>
The queue summaries.

Throws
On any transport or API error.
Inherited from ComposedClient.queuesList
- Defined in src/methods/queue.ts:35

queueUpdatePosition

queueUpdatePosition(
    queueId: string,
    currentIndex: number,
    device?: string,
): Promise<boolean>
Update the current playing position of a queue.
Parameters
- queueId: string
  The queue id.
- currentIndex: number
  The new current track index.
- Optionaldevice: string
  Device descriptor (must match the queue's creator). Defaults to the client device.
Returns Promise<boolean>
Whether the update succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.queueUpdatePosition
- Defined in src/methods/queue.ts:63

realtime

realtime(options?: Partial<RealtimeOptions>): RealtimeClient
Create a realtime ("now playing") client backed by Ynison.
Parameters
- options: Partial<RealtimeOptions> = {}
  Overrides for token, device identity and reconnection.
Returns RealtimeClient
A new realtime client.
Remarks
Realtime events are the only server-push channel Yandex Music offers — there are no HTTP webhooks. The returned RealtimeClient handles the handshake, keep-alive and reconnection; just subscribe and start(). By default trackChange events resolve the playing track via Client.tracks.

Requires the optional ws package (npm install ws).
Example
```
const rt = client.realtime();
rt.on('trackChange', ({ track }) => console.log('now playing:', track?.title));
await rt.start();
```
- Defined in src/client.ts:119

refreshAccessToken

refreshAccessToken(
    refreshToken: string,
    clientId?: string,
    clientSecret?: string,
): Promise<OAuthToken>
Exchange a refresh token for a fresh access token (OAuth refresh_token grant).

Device-flow tokens expire; persist OAuthToken.refreshToken from deviceAuth and call this to renew the access token without a new login. The response usually rotates the refresh token too — store the new one from the returned OAuthToken.
Parameters
- refreshToken: string
  The stored refresh token.
- OptionalclientId: string
  OAuth client id. Defaults to the Android app's id.
- OptionalclientSecret: string
  OAuth client secret. Defaults to the Android app's secret.
Returns Promise<OAuthToken>
The refreshed OAuthToken.

Throws
When the grant is rejected or the response cannot be parsed.

Throws
On any transport error.
Inherited from ComposedClient.refreshAccessToken
- Defined in src/methods/deviceAuth.ts:133

requestDeviceCode

requestDeviceCode(
    deviceId?: string,
    deviceName?: string,
    clientId?: string,
): Promise<DeviceCode>
Request a device/user code pair to start the OAuth Device Flow.
Parameters
- OptionaldeviceId: string
  Device id. Defaults to a random 10-character string.
- OptionaldeviceName: string
  Device name. Defaults to YandexMusicAPI.
- OptionalclientId: string
  OAuth client id. Defaults to the Android app's id.
Returns Promise<DeviceCode>
The issued DeviceCode.

Throws
When the response cannot be parsed.

Throws
On any transport or API error.
Inherited from ComposedClient.requestDeviceCode
- Defined in src/methods/deviceAuth.ts:74

rotorAccountStatus

rotorAccountStatus(): Promise<Status | null>
Fetch the rotor account status.

Returns Promise<Status | null>
The status, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorAccountStatus
- Defined in src/methods/radio.ts:44

rotorStationFeedback

rotorStationFeedback(
    station: string,
    type: RotorFeedbackType,
    options?: {
        batchId?: string;
        from?: string;
        timestamp?: number;
        totalPlayedSeconds?: number;
        trackId?: string | number;
    },
): Promise<boolean>
Send listening feedback for a station.
Parameters
- station: string
  Station id in type:tag form (for example user:onyourwave).
- type: RotorFeedbackType
  The kind of feedback.
- options: {
      batchId?: string;
      from?: string;
      timestamp?: number;
      totalPlayedSeconds?: number;
      trackId?: string | number;
  } = {}
  Optional feedback fields.
  - OptionalbatchId?: string
    Id of the track batch the event refers to.
  - Optionalfrom?: string
    Where playback started (for example mobile-radio-user-123).
  - Optionaltimestamp?: number
    Event time (seconds since the epoch). Defaults to now.
  - OptionaltotalPlayedSeconds?: number
    Seconds of the track played before the event.
  - OptionaltrackId?: string | number
    Id of the track the event refers to.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationFeedback
- Defined in src/methods/radio.ts:125

rotorStationFeedbackRadioStarted

rotorStationFeedbackRadioStarted(
    station: string,
    from: string,
    batchId?: string,
    timestamp?: number,
): Promise<boolean>
Shortcut for rotorStationFeedback(station, 'radioStarted', …).
Parameters
- station: string
  Station id.
- from: string
  Where playback started.
- OptionalbatchId: string
  Track batch id.
- Optionaltimestamp: number
  Event time (seconds since the epoch).
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.rotorStationFeedbackRadioStarted
- Defined in src/methods/radio.ts:163

rotorStationFeedbackSkip

rotorStationFeedbackSkip(
    station: string,
    trackId: string | number,
    totalPlayedSeconds: number,
    batchId?: string,
    timestamp?: number,
): Promise<boolean>
Shortcut for rotorStationFeedback(station, 'skip', …).
Parameters
- station: string
  Station id.
- trackId: string | number
  The track that was skipped.
- totalPlayedSeconds: number
  Seconds played before skipping.
- OptionalbatchId: string
  Track batch id.
- Optionaltimestamp: number
  Event time (seconds since the epoch).
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.rotorStationFeedbackSkip
- Defined in src/methods/radio.ts:225

rotorStationFeedbackTrackFinished

rotorStationFeedbackTrackFinished(
    station: string,
    trackId: string | number,
    totalPlayedSeconds: number,
    batchId?: string,
    timestamp?: number,
): Promise<boolean>
Shortcut for rotorStationFeedback(station, 'trackFinished', …).
Parameters
- station: string
  Station id.
- trackId: string | number
  The track that finished.
- totalPlayedSeconds: number
  Seconds played before finishing.
- OptionalbatchId: string
  Track batch id.
- Optionaltimestamp: number
  Event time (seconds since the epoch).
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.rotorStationFeedbackTrackFinished
- Defined in src/methods/radio.ts:200

rotorStationFeedbackTrackStarted

rotorStationFeedbackTrackStarted(
    station: string,
    trackId: string | number,
    batchId?: string,
    timestamp?: number,
): Promise<boolean>
Shortcut for rotorStationFeedback(station, 'trackStarted', …).
Parameters
- station: string
  Station id.
- trackId: string | number
  The track that started playing.
- OptionalbatchId: string
  Track batch id.
- Optionaltimestamp: number
  Event time (seconds since the epoch).
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.rotorStationFeedbackTrackStarted
- Defined in src/methods/radio.ts:181

rotorStationInfo

rotorStationInfo(station: string): Promise<StationResult[]>
Fetch information about a specific station.
Parameters
- station: string
  Station id in type:tag form (for example genre:pop).
Returns Promise<StationResult[]>
The matching station results.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationInfo
- Defined in src/methods/radio.ts:81

rotorStationsDashboard

rotorStationsDashboard(): Promise<Dashboard | null>
Fetch the personalized station dashboard.

Returns Promise<Dashboard | null>
The dashboard, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationsDashboard
- Defined in src/methods/radio.ts:55

rotorStationSettings2

rotorStationSettings2(
    station: string,
    moodEnergy: RotorMoodEnergy,
    diversity: RotorDiversity,
    language?: RotorLanguage,
    type?: RotorStationType,
): Promise<boolean>
Change the settings of a station.
Parameters
- station: string
  Station id.
- moodEnergy: RotorMoodEnergy
  The desired mood/energy.
- diversity: RotorDiversity
  The desired track diversity.
- language: RotorLanguage = 'not-russian'
  The desired language. Defaults to 'not-russian'.
- type: RotorStationType = 'rotor'
  The station type. Defaults to 'rotor'.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationSettings2
- Defined in src/methods/radio.ts:246

rotorStationsList

rotorStationsList(language?: string): Promise<StationResult[]>
Fetch the full list of available stations.
Parameters
- Optionallanguage: string
  Language for station info. Defaults to the client language.
Returns Promise<StationResult[]>
The list of stations.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationsList
- Defined in src/methods/radio.ts:67

rotorStationTracks

rotorStationTracks(
    station: string,
    settings2?: boolean,
    queue?: string | number,
): Promise<StationTracksResult | null>
Fetch the next batch of tracks from a station.
Parameters
- station: string
  Station id in type:tag form.
- settings2: boolean = true
  Use the second settings set (as official clients do). Defaults to true.
- Optionalqueue: string | number
  Id of the track that just played, to inform the next batch.
Returns Promise<StationTracksResult | null>
The track batch, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.rotorStationTracks
- Defined in src/methods/radio.ts:95

search

search(
    text: string,
    nocorrect?: boolean,
    type?: SearchType,
    page?: number,
    playlistInBest?: boolean,
): Promise<Search | null>
Search the catalogue.
Parameters
- text: string
  The query text.
- nocorrect: boolean = false
  When false, mistyped queries are auto-corrected. Defaults to false.
- type: SearchType = 'all'
  Entity type to search for. Defaults to all.
- page: number = 0
  Page index. Defaults to 0.
- playlistInBest: boolean = true
  Whether playlists may appear as the best match. Defaults to true.
Returns Promise<Search | null>
The search response, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.search
- Defined in src/methods/search.ts:34

searchSuggest

searchSuggest(part: string): Promise<Suggestions | null>
Fetch search suggestions for a partial query.
Parameters
- part: string
  The partial query text.
Returns Promise<Suggestions | null>
The suggestions, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.searchSuggest
- Defined in src/methods/search.ts:59

settings

settings(): Promise<Settings | null>
Fetch purchase offers and payment configuration.

Returns Promise<Settings | null>
The settings, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.settings
- Defined in src/methods/account.ts:93

tracks

tracks(
trackIds: string | number | (string | number)[],
withPositions?: boolean,
): Promise<Track[]>
Fetch one or many tracks by id.
Parameters
- trackIds: string | number | (string | number)[]
  A single id or a list of ids.
- withPositions: boolean = true
  Include album track positions. Defaults to true.
Returns Promise<Track[]>
The requested tracks.

Throws
On any transport or API error.
Inherited from ComposedClient.tracks
- Defined in src/methods/tracks.ts:74

tracksCredits

tracksCredits(trackId: string | number): Promise<Credits | null>
Fetch the production credits of a track.
Parameters
- trackId: string | number
  The track id.
Returns Promise<Credits | null>
The credits, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksCredits
- Defined in src/methods/credits.ts:27

tracksDisclaimer

tracksDisclaimer(trackId: string | number): Promise<Disclaimer | null>
Fetch the disclaimer of a track.
Parameters
- trackId: string | number
  The track id.
Returns Promise<Disclaimer | null>
The disclaimer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksDisclaimer
- Defined in src/methods/disclaimers.ts:27

tracksDownloadInfo

tracksDownloadInfo(
trackId: string | number,
getDirectLinks?: boolean,
): Promise<DownloadInfo[]>
Fetch the available download variants for a track.
Parameters
- trackId: string | number
  The track id.
- getDirectLinks: boolean = false
  Resolve direct file links eagerly. Defaults to false.
Returns Promise<DownloadInfo[]>
The list of download variants.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksDownloadInfo
- Defined in src/methods/tracks.ts:89

tracksFullInfo

tracksFullInfo(trackId: string | number): Promise<TrackFullInfo | null>
Fetch full information about a track.
Parameters
- trackId: string | number
  The track id.
Returns Promise<TrackFullInfo | null>
The full track info, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksFullInfo
- Defined in src/methods/tracks.ts:172

tracksLosslessInfo

tracksLosslessInfo(
trackId: string | number,
quality?: string,
): Promise<LosslessDownloadInfo | null>
Fetch lossless (FLAC) download info for a track via the /get-file-info endpoint.
Parameters
- trackId: string | number
  The track id (numeric, or "id:albumId").
- quality: string = 'lossless'
  Requested quality. Defaults to lossless.
Returns Promise<LosslessDownloadInfo | null>
The file info, or null when the endpoint returns none.

Remarks
Unlike tracksDownloadInfo (legacy lossy mp3/aac), this resolves the modern signed endpoint that can serve lossless FLAC. The returned stream is AES-CTR-encrypted (transport: encraw); LosslessDownloadInfo.download / LosslessDownloadInfo.downloadBytes decrypt it transparently. When a track has no lossless source the server falls back to a lossy codec — check LosslessDownloadInfo.isLossless / .codec.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksLosslessInfo
- Defined in src/methods/tracks.ts:112

tracksLyrics

tracksLyrics(
trackId: string | number,
format?: "TEXT" | "LRC",
): Promise<TrackLyrics | null>
Fetch the lyrics of a track.
Parameters
- trackId: string | number
  The track id.
- format: "TEXT" | "LRC" = 'TEXT'
  TEXT (plain) or LRC (time-synced). Defaults to TEXT.
Returns Promise<TrackLyrics | null>
The lyrics, or null when none exist.

Remarks
Requires authorization.

Throws
When called without authorization.

Throws
When the track has no lyrics.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksLyrics
- Defined in src/methods/tracks.ts:141

tracksSimilar

tracksSimilar(trackId: string | number): Promise<SimilarTracks | null>
Fetch tracks similar to a track.
Parameters
- trackId: string | number
  The track id.
Returns Promise<SimilarTracks | null>
The similar-tracks result, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksSimilar
- Defined in src/methods/tracks.ts:159

tracksTrailer

tracksTrailer(trackId: string | number): Promise<TrackTrailer | null>
Fetch the trailer of a track.
Parameters
- trackId: string | number
  The track id.
Returns Promise<TrackTrailer | null>
The trailer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.tracksTrailer
- Defined in src/methods/tracks.ts:185

trackSupplement

trackSupplement(trackId: string | number): Promise<Supplement | null>
Fetch supplementary information about a track (legacy lyrics, videos).
Parameters
- trackId: string | number
  The track id.
Returns Promise<Supplement | null>
The supplement, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.trackSupplement
- Defined in src/methods/tracks.ts:198

unpinAlbum

unpinAlbum(albumId: string | number): Promise<boolean>
Unpin an album.
Parameters
- albumId: string | number
  The album id.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.unpinAlbum
- Defined in src/methods/pins.ts:50

unpinArtist

unpinArtist(artistId: string | number): Promise<boolean>
Unpin an artist.
Parameters
- artistId: string | number
  The artist id.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.unpinArtist
- Defined in src/methods/pins.ts:74

unpinPlaylist

unpinPlaylist(uid: string | number, kind: string | number): Promise<boolean>
Unpin a playlist.
Parameters
- uid: string | number
  The playlist owner uid.
- kind: string | number
  The playlist kind.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.unpinPlaylist
- Defined in src/methods/pins.ts:100

unpinWave

unpinWave(seeds: string): Promise<boolean>
Unpin a wave.
Parameters
- seeds: string
  The wave seed identifier.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.unpinWave
- Defined in src/methods/pins.ts:124

usersDislikesArtists

usersDislikesArtists(userId?: string | number): Promise<Artist[]>
Fetch the user's disliked artists.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<Artist[]>
The disliked artists.

Remarks
The endpoint returns full artist objects (not like wrappers), so the result is Artist[].

Throws
On any transport or API error.
Inherited from ComposedClient.usersDislikesArtists
- Defined in src/methods/likes.ts:298

usersDislikesArtistsAdd

usersDislikesArtistsAdd(
artistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Dislike one or many artists.
Parameters
- artistIds: string | number | (string | number)[]
  Artist id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersDislikesArtistsAdd
- Defined in src/methods/likes.ts:311

usersDislikesArtistsRemove

usersDislikesArtistsRemove(
artistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the dislike from one or many artists.
Parameters
- artistIds: string | number | (string | number)[]
  Artist id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersDislikesArtistsRemove
- Defined in src/methods/likes.ts:325

usersDislikesTracks

usersDislikesTracks(userId?: string | number): Promise<TracksList | null>
Fetch the user's disliked tracks.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<TracksList | null>
The disliked-tracks library, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersDislikesTracks
- Defined in src/methods/likes.ts:254

usersDislikesTracksAdd

usersDislikesTracksAdd(
trackIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Dislike one or many tracks.
Parameters
- trackIds: string | number | (string | number)[]
  Track id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersDislikesTracksAdd
- Defined in src/methods/likes.ts:268

usersDislikesTracksRemove

usersDislikesTracksRemove(
trackIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the dislike from one or many tracks.
Parameters
- trackIds: string | number | (string | number)[]
  Track id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersDislikesTracksRemove
- Defined in src/methods/likes.ts:282

usersLikesAlbums

usersLikesAlbums(userId?: string | number): Promise<Like[]>
Fetch the user's liked albums.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<Like[]>
The liked albums.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesAlbums
- Defined in src/methods/likes.ts:213

usersLikesAlbumsAdd

usersLikesAlbumsAdd(
albumIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Like one or many albums.
Parameters
- albumIds: string | number | (string | number)[]
  Album id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesAlbumsAdd
- Defined in src/methods/likes.ts:145

usersLikesAlbumsRemove

usersLikesAlbumsRemove(
albumIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the like from one or many albums.
Parameters
- albumIds: string | number | (string | number)[]
  Album id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesAlbumsRemove
- Defined in src/methods/likes.ts:156

usersLikesArtists

usersLikesArtists(userId?: string | number): Promise<Artist[]>
Fetch the user's liked artists.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<Artist[]>
The liked artists.

Remarks
The endpoint returns full artist objects (not like wrappers), so the result is Artist[].

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesArtists
- Defined in src/methods/likes.ts:228

usersLikesArtistsAdd

usersLikesArtistsAdd(
artistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Like one or many artists.
Parameters
- artistIds: string | number | (string | number)[]
  Artist id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesArtistsAdd
- Defined in src/methods/likes.ts:117

usersLikesArtistsRemove

usersLikesArtistsRemove(
artistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the like from one or many artists.
Parameters
- artistIds: string | number | (string | number)[]
  Artist id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesArtistsRemove
- Defined in src/methods/likes.ts:131

usersLikesClips

usersLikesClips(
    userId?: string | number,
    page?: number,
    pageSize?: number,
): Promise<ClipsWillLike | null>
Fetch a page of the user's liked clips.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
- page: number = 0
  Page index (0-based). Defaults to 0.
- pageSize: number = 20
  Clips per page. Defaults to 20.
Returns Promise<ClipsWillLike | null>
The liked clips, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesClips
- Defined in src/methods/likes.ts:341

usersLikesClipsAdd

usersLikesClipsAdd(
clipId: string | number,
userId?: string | number,
): Promise<boolean>
Like a clip.
Parameters
- clipId: string | number
  The clip id.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesClipsAdd
- Defined in src/methods/likes.ts:358

usersLikesClipsRemove

usersLikesClipsRemove(
clipId: string | number,
userId?: string | number,
): Promise<boolean>
Remove the like from a clip.
Parameters
- clipId: string | number
  The clip id.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesClipsRemove
- Defined in src/methods/likes.ts:372

usersLikesPlaylists

usersLikesPlaylists(userId?: string | number): Promise<Like[]>
Fetch the user's liked playlists.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<Like[]>
The liked playlists.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesPlaylists
- Defined in src/methods/likes.ts:241

usersLikesPlaylistsAdd

usersLikesPlaylistsAdd(
playlistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Like one or many playlists.
Parameters
- playlistIds: string | number | (string | number)[]
  Playlist id(s) in ownerId:kind form.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesPlaylistsAdd
- Defined in src/methods/likes.ts:170

usersLikesPlaylistsRemove

usersLikesPlaylistsRemove(
playlistIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the like from one or many playlists.
Parameters
- playlistIds: string | number | (string | number)[]
  Playlist id(s) in ownerId:kind form.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesPlaylistsRemove
- Defined in src/methods/likes.ts:184

usersLikesTracks

usersLikesTracks(userId?: string | number): Promise<TracksList | null>
Fetch the user's liked tracks.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<TracksList | null>
The liked-tracks library, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersLikesTracks
- Defined in src/methods/likes.ts:198

usersLikesTracksAdd

usersLikesTracksAdd(
trackIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Like one or many tracks.
Parameters
- trackIds: string | number | (string | number)[]
  Track id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesTracksAdd
- Defined in src/methods/likes.ts:92

usersLikesTracksRemove

usersLikesTracksRemove(
trackIds: string | number | (string | number)[],
userId?: string | number,
): Promise<boolean>
Remove the like from one or many tracks.
Parameters
- trackIds: string | number | (string | number)[]
  Track id(s).
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.
Inherited from ComposedClient.usersLikesTracksRemove
- Defined in src/methods/likes.ts:103

usersPlaylists

usersPlaylists(
kind: string | number | (string | number)[],
userId?: string | number,
): Promise<Playlist | Playlist[] | null>
Fetch one playlist (by a single kind) or several (by a list of kinds).
Parameters
- kind: string | number | (string | number)[]
  A single playlist kind, or a list of kinds.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | Playlist[] | null>
A single Playlist, a list of them, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylists
- Defined in src/methods/playlists.ts:56

usersPlaylistsChange

usersPlaylistsChange(
    kind: string | number,
    diff: string,
    revision?: number,
    userId?: string | number,
): Promise<Playlist | null>
Apply a raw diff to a playlist.
Parameters
- kind: string | number
  The playlist kind.
- diff: string
  The serialized diff (see Difference).
- revision: number = 1
  The playlist revision. Defaults to 1.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsChange
- Defined in src/methods/playlists.ts:194

usersPlaylistsCreate

usersPlaylistsCreate(
    title: string,
    visibility?: PlaylistVisibility,
    userId?: string | number,
): Promise<Playlist | null>
Create a new playlist.
Parameters
- title: string
  The playlist title.
- visibility: PlaylistVisibility = 'public'
  Access modifier. Defaults to 'public'.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The created playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsCreate
- Defined in src/methods/playlists.ts:98

usersPlaylistsDelete

usersPlaylistsDelete(
kind: string | number,
userId?: string | number,
): Promise<boolean>
Delete a playlist.
Parameters
- kind: string | number
  The playlist kind.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsDelete
- Defined in src/methods/playlists.ts:117

usersPlaylistsDeleteTrack

usersPlaylistsDeleteTrack(
    kind: string | number,
    from: number,
    to: number,
    revision?: number,
    userId?: string | number,
): Promise<Playlist | null>
Remove a range of tracks from a playlist.
Parameters
- kind: string | number
  The playlist kind.
- from: number
  Start index (inclusive).
- to: number
  End index (exclusive).
- revision: number = 1
  The playlist revision. Defaults to 1.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsDeleteTrack
- Defined in src/methods/playlists.ts:241

usersPlaylistsDescription

usersPlaylistsDescription(
    kind: string | number,
    description: string,
    userId?: string | number,
): Promise<Playlist | null>
Change a playlist's description.
Parameters
- kind: string | number
  The playlist kind.
- description: string
  The new description.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsDescription
- Defined in src/methods/playlists.ts:173

usersPlaylistsInsertTrack

usersPlaylistsInsertTrack(
    kind: string | number,
    trackId: string | number,
    albumId: string | number,
    at?: number,
    revision?: number,
    userId?: string | number,
): Promise<Playlist | null>
Insert a track into a playlist at the given index.
Parameters
- kind: string | number
  The playlist kind.
- trackId: string | number
  The track id to insert.
- albumId: string | number
  The album the track belongs to.
- at: number = 0
  The insertion index. Defaults to 0.
- revision: number = 1
  The playlist revision. Defaults to 1.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsInsertTrack
- Defined in src/methods/playlists.ts:218

usersPlaylistsKinds

usersPlaylistsKinds(userId?: string | number): Promise<number[]>
Fetch the kinds (ids) of all playlists owned by a user.
Parameters
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<number[]>
The list of playlist kinds.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsKinds
- Defined in src/methods/playlists.ts:378

usersPlaylistsList

usersPlaylistsList(userId?: string | number): Promise<Playlist[]>
Fetch every playlist owned by a user.
Parameters
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist[]>
The user's playlists.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsList
- Defined in src/methods/playlists.ts:274

usersPlaylistsName

usersPlaylistsName(
    kind: string | number,
    name: string,
    userId?: string | number,
): Promise<Playlist | null>
Rename a playlist.
Parameters
- kind: string | number
  The playlist kind.
- name: string
  The new title.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsName
- Defined in src/methods/playlists.ts:133

usersPlaylistsRecommendations

usersPlaylistsRecommendations(
kind: string | number,
userId?: string | number,
): Promise<PlaylistRecommendations | null>
Fetch track recommendations for a playlist.
Parameters
- kind: string | number
  The playlist kind.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<PlaylistRecommendations | null>
The recommendations, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsRecommendations
- Defined in src/methods/playlists.ts:79

usersPlaylistsTrailer

usersPlaylistsTrailer(
kind: string | number,
userId?: string | number,
): Promise<PlaylistTrailer | null>
Fetch the trailer of a playlist.
Parameters
- kind: string | number
  The playlist kind.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<PlaylistTrailer | null>
The trailer, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsTrailer
- Defined in src/methods/playlists.ts:361

usersPlaylistsVisibility

usersPlaylistsVisibility(
    kind: string | number,
    visibility: PlaylistVisibility,
    userId?: string | number,
): Promise<Playlist | null>
Change a playlist's visibility.
Parameters
- kind: string | number
  The playlist kind.
- visibility: PlaylistVisibility
  The new visibility.
- OptionaluserId: string | number
  Owner user id. Defaults to the authenticated account.
Returns Promise<Playlist | null>
The updated playlist, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPlaylistsVisibility
- Defined in src/methods/playlists.ts:153

usersPresaves

usersPresaves(
    includeReleased?: boolean,
    includeUpcoming?: boolean,
    userId?: string | number,
): Promise<Presaves | null>
Fetch the user's pre-saved albums.
Parameters
- includeReleased: boolean = true
  Include albums that have since been released. Defaults to true.
- includeUpcoming: boolean = true
  Include albums not yet released. Defaults to true.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<Presaves | null>
The pre-saves, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPresaves
- Defined in src/methods/presaves.ts:29

usersPresavesAdd

usersPresavesAdd(
    albumId: string | number,
    likeAfterRelease?: boolean,
    userId?: string | number,
): Promise<boolean>
Pre-save an album.
Parameters
- albumId: string | number
  The album id.
- likeAfterRelease: boolean = true
  Automatically like the album once released. Defaults to true.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPresavesAdd
- Defined in src/methods/presaves.ts:51

usersPresavesRemove

usersPresavesRemove(
albumId: string | number,
userId?: string | number,
): Promise<boolean>
Remove an album pre-save.
Parameters
- albumId: string | number
  The album id.
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<boolean>
Whether the operation succeeded.

Throws
On any transport or API error.
Inherited from ComposedClient.usersPresavesRemove
- Defined in src/methods/presaves.ts:72

usersSettings

usersSettings(userId?: string | number): Promise<UserSettings | null>
Fetch a user's library settings.
Parameters
- OptionaluserId: string | number
  Target user id. Defaults to the authenticated account.
Returns Promise<UserSettings | null>
The user settings, or null.

Throws
On any transport or API error.
Inherited from ComposedClient.usersSettings
- Defined in src/methods/playlists.ts:40

Class Client

Example

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Client

Properties

OptionalaccountUid

baseUrl

device

language

Optionalme

OptionalonUnknownField

reportUnknownFields

Readonlyrequest

Optionaltoken

Methods

accountExperiments

Returns Promise<Experiments | null>

Throws

accountExperimentsDetails

Returns Promise<ExperimentsDetails | null>

Throws

accountSettings

Returns Promise<UserSettings | null>

Throws

accountSettingsSet

Parameters

Returns Promise<UserSettings | null>

Throws

accountStatus

Returns Promise<Status | null>

Throws

afterTrack

Parameters

Returns Promise<ShotEvent | null>

Throws

albums

Parameters

Returns Promise<Album[]>

Throws

albumsDisclaimer

Parameters

Returns Promise<Disclaimer | null>

Throws

albumsSimilarEntities

Parameters

Returns Promise<AlbumSimilarEntities | null>

Throws

albumsTrailer

Parameters

Returns Promise<AlbumTrailer | null>

Throws

albumsWithTracks

Parameters

Returns Promise<Album | null>

Throws

artists

Parameters

Returns Promise<Artist[]>

Throws

artistsAbout

Parameters

Returns Promise<ArtistAbout | null>

Throws

artistsAlsoAlbums

Parameters

Returns Promise<ArtistAlbums | null>

Throws

artistsBriefInfo

Parameters

Returns Promise<BriefInfo | null>

Throws

artistsClips

`Optional`accountUid

`Optional`me

`Optional`onUnknownField

`Readonly`request

`Optional`token