Client
Server
Reference / @open-music-sdk/client-catalog / tCatalogFunctions
Interface: tCatalogFunctions
Defined in: clients/client-catalog/src/namespace.ts:17
Every function of this package by its name, each saying what it is for, as it does where it is declared.
It is said twice because of how the package is published: its declarations are rolled into one file, where the modules the functions are declared in become lists of names, with nothing of what was written above each function. An interface keeps what is written above its members. So this is what catalog(client) is typed from, and what lets an editor say of music.catalog.getSong what it says of getSong. A test holds the two to the same names, the same types and the same words, with each argument said the same way; what a member says it hands over, and throws, is the bound form's own.
Properties
getActivities
ts
readonly getActivities: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tActivitiesResponse, tStorefrontOption, object>], tActivitiesResponse, Promise<tActivity[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:683
The activities with the ids given.
Param
ids
The activities' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the activities.
Returns
The activities, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getActivity
ts
readonly getActivity: tEndpoint<[id: string, options?: tEndpointOptions<tActivitiesResponse, tStorefrontOption, object>], tActivitiesResponse, Promise<tActivity>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:669
The activity with an id.
Param
id
The activity's id.
Param
options
The storefront to ask in, and what to send beside the activity.
Returns
The activity, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no activity, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getActivityRelationship
ts
readonly getActivityRelationship: tRelationshipEndpoint<tActivityRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:701
One relationship of an activity, such as its playlists, a page at a time.
Param
id
The activity's id.
Param
name
The relationship's name, one of the activity's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbum
ts
readonly getAlbum: tEndpoint<[id: string, options?: tEndpointOptions<tAlbumsResponse, tStorefrontOption, tViewsOption<tAlbumViews>>], tAlbumsResponse, Promise<tAlbum>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:105
The album with an id.
Param
id
The album's id.
Param
options
The storefront to ask in, the views to send with the album, and what else to send beside it.
Returns
The album, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no album, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbumRelationship
ts
readonly getAlbumRelationship: tRelationshipEndpoint<Omit<tAlbumRelationships, "library">, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:167
One relationship of an album, such as its tracks, a page at a time. The library relationship needs the listener, and is not among the names.
Param
id
The album's id.
Param
name
The relationship's name, one of the album's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbums
ts
readonly getAlbums: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tAlbumsResponse, tStorefrontOption, object>], tAlbumsResponse, Promise<tAlbum[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:119
The albums with the ids given.
Param
ids
The albums' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the albums.
Returns
The albums, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbumsByEquivalents
ts
readonly getAlbumsByEquivalents: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tAlbumsResponse, tStorefrontOption, tRestrictOption>], tAlbumsResponse, Promise<tAlbum[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:149
The albums in this storefront that are the equivalents of the albums with the ids given, which may be from another.
Param
values
The ids of the albums to find the equivalents of, 1 to 300 of them; they may be another storefront's.
Param
options
The storefront to ask in, which is where the equivalents are looked for; what to leave out of them; and what to send beside them.
Returns
The albums, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbumsByUpc
ts
readonly getAlbumsByUpc: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tAlbumsResponse, tStorefrontOption, object>], tAlbumsResponse, Promise<tAlbum[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:133
The albums with the UPCs given.
Param
values
The UPCs, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the albums.
Returns
The albums, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAlbumView
ts
readonly getAlbumView: tViewEndpoint<tAlbumViews>;Defined in: clients/client-catalog/src/namespace.ts:185
One view of an album, such as other-versions, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.
Param
id
The album's id.
Param
name
The view's name, one of the album's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most. The view's own attributes are not handed over.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAppleCurator
ts
readonly getAppleCurator: tEndpoint<[id: string, options?: tEndpointOptions<tAppleCuratorsResponse, tStorefrontOption, object>], tAppleCuratorsResponse, Promise<tAppleCurator>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:624
The Apple curator with an id.
Param
id
The Apple curator's id.
Param
options
The storefront to ask in, and what to send beside the Apple curator.
Returns
The Apple curator, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no Apple curator, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAppleCuratorRelationship
ts
readonly getAppleCuratorRelationship: tRelationshipEndpoint<tAppleCuratorRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:656
One relationship of an Apple curator, such as their playlists, a page at a time.
Param
id
The Apple curator's id.
Param
name
The relationship's name, one of the Apple curator's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getAppleCurators
ts
readonly getAppleCurators: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tAppleCuratorsResponse, tStorefrontOption, object>], tAppleCuratorsResponse, Promise<tAppleCurator[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:638
The Apple curators with the ids given.
Param
ids
The Apple curators' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the Apple curators.
Returns
The Apple curators, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getArtist
ts
readonly getArtist: tEndpoint<[id: string, options?: tEndpointOptions<tArtistsResponse, tStorefrontOption, tViewsOption<tArtistViews>>], tArtistsResponse, Promise<tArtist>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:198
The artist with an id.
Param
id
The artist's id.
Param
options
The storefront to ask in, the views to send with the artist, and what else to send beside it.
Returns
The artist, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no artist, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getArtistRelationship
ts
readonly getArtistRelationship: tRelationshipEndpoint<tArtistRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:230
One relationship of an artist, such as their albums, a page at a time.
Param
id
The artist's id.
Param
name
The relationship's name, one of the artist's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getArtists
ts
readonly getArtists: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tArtistsResponse, tStorefrontOption, object>], tArtistsResponse, Promise<tArtist[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:212
The artists with the ids given.
Param
ids
The artists' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the artists.
Returns
The artists, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getArtistView
ts
readonly getArtistView: tViewEndpoint<tArtistViews>;Defined in: clients/client-catalog/src/namespace.ts:248
One view of an artist, such as top-songs, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.
Param
id
The artist's id.
Param
name
The view's name, one of the artist's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most. The view's own attributes are not handed over.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getCatalogResources
ts
readonly getCatalogResources: tEndpoint<[ids: Readonly<Partial<Record<tCatalogType, readonly string[] | undefined>>>, options?: tCatalogResourcesOptions], tResourceCollectionResponse, Promise<tResource[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:865
Resources of several types in one request, by their ids: { songs: [...], albums: [...] }. One type at least has to be given.
Param
ids
The ids by type, such as { songs: ["1"], albums: ["2"] }: 1 to 32 types with 1 to 300 ids between them; a type whose list is undefined is left out.
Param
options
The storefront to ask in, and what to send beside the resources.
Returns
The resources, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getCharts
ts
readonly getCharts: tEndpoint<[options: tChartsOptions], tChartResponse, Promise<tChartResponse>, "answer">;Defined in: clients/client-catalog/src/namespace.ts:850
The charts of a storefront, by type of resource, each one a first page. Each type is a list of charts, since one type can have several. limit and offset apply to every chart. A next link of a chart answers with charts by type again, not with a page, as it did against the live API on 18 October 2026, so paginate stops after the first page: to get more of a chart, ask again with a larger offset.
Param
options
The types to chart, which have to be given; one chart by name; one genre by id; the city or global charts; the storefront to ask in; and what to send beside the charts.
Returns
What Apple answered: the charts by type under results, each a first page with a next of its own.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getCurator
ts
readonly getCurator: tEndpoint<[id: string, options?: tEndpointOptions<tCuratorsResponse, tStorefrontOption, object>], tCuratorsResponse, Promise<tCurator>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:579
The curator with an id.
Param
id
The curator's id.
Param
options
The storefront to ask in, and what to send beside the curator.
Returns
The curator, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no curator, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getCuratorRelationship
ts
readonly getCuratorRelationship: tRelationshipEndpoint<tCuratorRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:611
One relationship of a curator, such as their playlists, a page at a time.
Param
id
The curator's id.
Param
name
The relationship's name, one of the curator's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getCurators
ts
readonly getCurators: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tCuratorsResponse, tStorefrontOption, object>], tCuratorsResponse, Promise<tCurator[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:593
The curators with the ids given.
Param
ids
The curators' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the curators.
Returns
The curators, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getGenre
ts
readonly getGenre: tEndpoint<[id: string, options?: tEndpointOptions<tGenresResponse, tStorefrontOption, object>], tGenresResponse, Promise<tGenre>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:537
The genre with an id.
Param
id
The genre's id.
Param
options
The storefront to ask in, and what to send beside the genre.
Returns
The genre, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no genre, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getGenres
ts
readonly getGenres: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tGenresResponse, tStorefrontOption, object>], tGenresResponse, Promise<tGenre[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:551
The genres with the ids given.
Param
ids
The genres' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the genres.
Returns
The genres, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getLanguageTag
ts
readonly getLanguageTag: tEndpoint<[acceptLanguage: readonly string[], options?: tLanguageTagOptions], tLangageTagResponse, Promise<tLangageTagResponse>, "answer">;Defined in: clients/client-catalog/src/namespace.ts:892
The language a storefront would answer in, given the ones a reader accepts, best first, such as ["fr-CA", "fr", "en"]: the tag to pass as language to the other functions.
Param
acceptLanguage
The languages a reader accepts, best first, as tags such as "fr-CA", 1 to 300 of them.
Param
options
The storefront to ask about, and what to send beside the tag.
Returns
What Apple answered: the tag under results.tag.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getLiveRadioStations
ts
readonly getLiveRadioStations: tEndpoint<[options?: tLiveRadioStationsOptions], tStationsResponse, Promise<tStation[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:878
The live radio stations of Apple Music, such as Apple Music 1.
Param
options
The storefront to ask in, and what to send beside the stations.
Returns
The live stations, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideo
ts
readonly getMusicVideo: tEndpoint<[id: string, options?: tEndpointOptions<tMusicVideosResponse, tStorefrontOption, tViewsOption<tMusicVideoViews>>], tMusicVideosResponse, Promise<tMusicVideo>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:338
The music video with an id.
Param
id
The music video's id.
Param
options
The storefront to ask in, the views to send with the music video, and what else to send beside it.
Returns
The music video, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no music video, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideoRelationship
ts
readonly getMusicVideoRelationship: tRelationshipEndpoint<Omit<tMusicVideoRelationships, "library">, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:400
One relationship of a music video, such as its artists, a page at a time. The library relationship needs the listener, and is not among the names.
Param
id
The music video's id.
Param
name
The relationship's name, one of the music video's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideos
ts
readonly getMusicVideos: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tMusicVideosResponse, tStorefrontOption, object>], tMusicVideosResponse, Promise<tMusicVideo[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:352
The music videos with the ids given.
Param
ids
The music videos' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the music videos.
Returns
The music videos, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideosByEquivalents
ts
readonly getMusicVideosByEquivalents: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tMusicVideosResponse, tStorefrontOption, tRestrictOption>], tMusicVideosResponse, Promise<tMusicVideo[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:382
The music videos in this storefront that are the equivalents of the ones with the ids given, which may be from another.
Param
values
The ids of the music videos to find the equivalents of, 1 to 300 of them; they may be another storefront's.
Param
options
The storefront to ask in, which is where the equivalents are looked for; what to leave out of them; and what to send beside them.
Returns
The music videos, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideosByIsrc
ts
readonly getMusicVideosByIsrc: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tMusicVideosResponse, tStorefrontOption, object>], tMusicVideosResponse, Promise<tMusicVideo[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:366
The music videos with the ISRCs given. One ISRC may be that of more than one music video.
Param
values
The ISRCs, 1 to 300 of them; one ISRC may be that of more than one music video.
Param
options
The storefront to ask in, and what to send beside the music videos.
Returns
The music videos, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getMusicVideoView
ts
readonly getMusicVideoView: tViewEndpoint<tMusicVideoViews>;Defined in: clients/client-catalog/src/namespace.ts:419
One view of a music video, such as more-by-artist, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.
Param
id
The music video's id.
Param
name
The view's name, one of the music video's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most. The view's own attributes are not handed over.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getPlaylist
ts
readonly getPlaylist: tEndpoint<[id: string, options?: tEndpointOptions<tPlaylistsResponse, tStorefrontOption, tViewsOption<tPlaylistViews>>], tPlaylistsResponse, Promise<tPlaylist>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:261
The playlist with an id.
Param
id
The playlist's id.
Param
options
The storefront to ask in, the views to send with the playlist, and what else to send beside it.
Returns
The playlist, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no playlist, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getPlaylistRelationship
ts
readonly getPlaylistRelationship: tRelationshipEndpoint<Omit<tPlaylistRelationships, "library">, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:307
One relationship of a playlist, such as its tracks, a page at a time. The library relationship needs the listener, and is not among the names.
Param
id
The playlist's id.
Param
name
The relationship's name, one of the playlist's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getPlaylists
ts
readonly getPlaylists: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tPlaylistsResponse, tStorefrontOption, object>], tPlaylistsResponse, Promise<tPlaylist[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:275
The playlists with the ids given.
Param
ids
The playlists' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the playlists.
Returns
The playlists, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getPlaylistsByStorefrontChart
ts
readonly getPlaylistsByStorefrontChart: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tPlaylistsResponse, tStorefrontOption, object>], tPlaylistsResponse, Promise<tPlaylist[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:289
The chart playlists of the storefronts with the ids given: each storefront's own charts, kept as playlists.
Param
values
The storefronts' ids, 1 to 300 of them; each one such as "gb".
Param
options
The storefront to ask in, and what to send beside the playlists.
Returns
The playlists, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getPlaylistView
ts
readonly getPlaylistView: tViewEndpoint<tPlaylistViews>;Defined in: clients/client-catalog/src/namespace.ts:325
One view of a playlist, such as featured-artists, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.
Param
id
The playlist's id.
Param
name
The view's name, one of the playlist's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most. The view's own attributes are not handed over.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getRecordLabel
ts
readonly getRecordLabel: tEndpoint<[id: string, options?: tEndpointOptions<tRecordLabelsResponse, tStorefrontOption, tViewsOption<tRecordLabelViews>>], tRecordLabelsResponse, Promise<tRecordLabel>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:715
The record label with an id.
Param
id
The record label's id.
Param
options
The storefront to ask in, the views to send with the record label, and what else to send beside it.
Returns
The record label, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no record label, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getRecordLabels
ts
readonly getRecordLabels: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tRecordLabelsResponse, tStorefrontOption, object>], tRecordLabelsResponse, Promise<tRecordLabel[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:729
The record labels with the ids given.
Param
ids
The record labels' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the record labels.
Returns
The record labels, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getRecordLabelView
ts
readonly getRecordLabelView: tViewEndpoint<tRecordLabelViews>;Defined in: clients/client-catalog/src/namespace.ts:748
One view of a record label, such as latest-releases, a page at a time. Its next link kept only its offset against the live API on 18 October 2026, so the view's own attributes come on the first page alone.
Param
id
The record label's id.
Param
name
The view's name, one of the record label's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, whether to send the view's own attributes, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most. The view's own attributes are not handed over.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSearchHints
ts
readonly getSearchHints: tEndpoint<[term: string, options?: tSearchHintsOptions], tSearchHintsResponse, Promise<tSearchHintsResponse>, "answer">;Defined in: clients/client-catalog/src/namespace.ts:820
The terms a search might be for, given the start of one: what to offer as someone types.
Param
term
The start of a search, 1 to 256 characters.
Param
options
The storefront to ask in, and what to send beside the terms.
Returns
What Apple answered: the terms under results.terms.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSearchSuggestions
ts
readonly getSearchSuggestions: tEndpoint<[term: string, options: tSearchSuggestionsOptions], tSearchSuggestionsResponse, Promise<tSearchSuggestionsResponse>, "answer">;Defined in: clients/client-catalog/src/namespace.ts:834
Suggestions for a search, given the start of one: terms to search for, resources that match, or both.
Param
term
The start of a search, 1 to 256 characters.
Param
options
The kinds of suggestion to make, which have to be given; the types the top results may be; the storefront to ask in; and what to send beside the suggestions.
Returns
What Apple answered: the suggestions under results.suggestions, each saying its kind.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSong
ts
readonly getSong: tEndpoint<[id: string, options?: tEndpointOptions<tSongsResponse, tStorefrontOption, object>], tSongsResponse, Promise<tSong>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:30
The song with an id.
Param
id
The song's id.
Param
options
The storefront to ask in, and what to send beside the song.
Returns
The song, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no song, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSongRelationship
ts
readonly getSongRelationship: tRelationshipEndpoint<Omit<tSongRelationships, "library">, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:92
One relationship of a song, such as its albums, a page at a time. The library relationship needs the listener, and is not among the names.
Param
id
The song's id.
Param
name
The relationship's name, one of the song's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSongs
ts
readonly getSongs: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tSongsResponse, tStorefrontOption, object>], tSongsResponse, Promise<tSong[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:44
The songs with the ids given.
Param
ids
The songs' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the songs.
Returns
The songs, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSongsByEquivalents
ts
readonly getSongsByEquivalents: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tSongsResponse, tStorefrontOption, tRestrictOption>], tSongsResponse, Promise<tSong[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:74
The songs in this storefront that are the equivalents of the songs with the ids given, which may be from another.
Param
values
The ids of the songs to find the equivalents of, 1 to 300 of them; they may be another storefront's.
Param
options
The storefront to ask in, which is where the equivalents are looked for; what to leave out of them; and what to send beside them.
Returns
The songs, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getSongsByIsrc
ts
readonly getSongsByIsrc: tEndpoint<[values: readonly string[], options?: tEndpointOptions<tSongsResponse, tStorefrontOption, object>], tSongsResponse, Promise<tSong[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:58
The songs with the ISRCs given. One ISRC may be that of more than one song.
Param
values
The ISRCs, 1 to 300 of them; one ISRC may be that of more than one song.
Param
options
The storefront to ask in, and what to send beside the songs.
Returns
The songs, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStation
ts
readonly getStation: tEndpoint<[id: string, options?: tEndpointOptions<tStationsResponse, tStorefrontOption, object>], tStationsResponse, Promise<tStation>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:432
The station with an id.
Param
id
The station's id.
Param
options
The storefront to ask in, and what to send beside the station.
Returns
The station, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no station, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStationGenre
ts
readonly getStationGenre: tEndpoint<[id: string, options?: tEndpointOptions<tStationGenresResponse, tStorefrontOption, object>], tStationGenresResponse, Promise<tStationGenre>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:477
The station genre with an id.
Param
id
The station genre's id.
Param
options
The storefront to ask in, and what to send beside the station genre.
Returns
The station genre, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer holds no station genre, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStationGenreRelationship
ts
readonly getStationGenreRelationship: tRelationshipEndpoint<tStationGenreRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:524
One relationship of a station genre, such as its stations, a page at a time.
Param
id
The station genre's id.
Param
name
The relationship's name, one of the station genre's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStationGenres
ts
readonly getStationGenres: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tStationGenresResponse, tStorefrontOption, object>], tStationGenresResponse, Promise<tStationGenre[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:491
The station genres with the ids given.
Param
ids
The station genres' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the station genres.
Returns
The station genres, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStationRelationship
ts
readonly getStationRelationship: tRelationshipEndpoint<tStationRelationships, tStorefrontOption>;Defined in: clients/client-catalog/src/namespace.ts:464
One relationship of a station, such as its radio-show, a page at a time.
Param
id
The station's id.
Param
name
The relationship's name, one of the station's as the type has them; Apple says whether there is such a one.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every item of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStations
ts
readonly getStations: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tStationsResponse, tStorefrontOption, object>], tStationsResponse, Promise<tStation[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:446
The stations with the ids given.
Param
ids
The stations' ids, 1 to 300 of them.
Param
options
The storefront to ask in, and what to send beside the stations.
Returns
The stations, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStorefront
ts
readonly getStorefront: tEndpoint<[id: string, options?: tEndpointOptions<tStorefrontsResponse, object, object>], tStorefrontsResponse, Promise<tStorefront>, "resource">;Defined in: clients/client-catalog/src/namespace.ts:761
The storefront with an id, such as "gb".
Param
id
The storefront's id.
Param
options
What to send beside the storefront.
Returns
The storefront, out of data.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues, or if the answer holds no storefront, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
getStorefronts
ts
readonly getStorefronts: tEndpoint<[ids: readonly string[], options?: tEndpointOptions<tStorefrontsResponse, object, object>], tStorefrontsResponse, Promise<tStorefront[]>, "resources">;Defined in: clients/client-catalog/src/namespace.ts:774
The storefronts with the ids given.
Param
ids
The storefronts' ids, 1 to 300 of them; each one such as "gb".
Param
options
What to send beside the storefronts.
Returns
The storefronts, out of data: an empty list where Apple sends none.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues, or if the answer is no object or its data is there and is no list, which is an ApiError; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
listGenres
ts
readonly listGenres: tEndpoint<[options?: tReadOptions<tPaged<tGenresResponse>> & tStorefrontOption & object & tWalkOptions], tPaged<tGenresResponse>, AsyncIterable<tGenre, any, any>, "pages">;Defined in: clients/client-catalog/src/namespace.ts:566
Every genre the charts are kept by, a page at a time.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every genre of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
listStationGenres
ts
readonly listStationGenres: tEndpoint<[options?: tReadOptions<tPaged<tStationGenresResponse>> & tStorefrontOption & object & tWalkOptions], tPaged<tStationGenresResponse>, AsyncIterable<tStationGenre, any, any>, "pages">;Defined in: clients/client-catalog/src/namespace.ts:506
Every station genre, a page at a time.
Param
options
The storefront to ask in, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every station genre of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
listStorefronts
ts
readonly listStorefronts: tEndpoint<[options?: tReadOptions<tPaged<tStorefrontsResponse>> & object & tWalkOptions], tPaged<tStorefrontsResponse>, AsyncIterable<tStorefront, any, any>, "pages">;Defined in: clients/client-catalog/src/namespace.ts:789
Every storefront, a page at a time.
Param
options
How many to send in one page, where to start, what to send beside them, and the signal and schema of the request.
Returns
Every storefront of every page, asking for each page as the one before runs out; maxPages says how many pages at most.
Throws
TypeError if an argument is not what it should be, thrown from the call itself, before a loop starts.
Throws
AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues, or if a page is no object or its data is there and is no list, which is an ApiError, each thrown as the loop asks for the page; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.
searchCatalog
ts
readonly searchCatalog: tEndpoint<[term: string, options: tSearchCatalogOptions], tSearchResponse, Promise<tSearchResponse>, "answer">;Defined in: clients/client-catalog/src/namespace.ts:807
Searches the catalog for a term, and resolves to the results by type, each one a first page. limit and offset apply to every type asked for. A next link of a search answers with results by type again, not with a page, so paginate stops after the first page: to get more of one type, ask again with a larger offset. The link keeps the term and the types and leaves out limit, as it did against the live API on 18 October 2026.
Param
term
What to search for, 1 to 256 characters.
Param
options
The types to look for, which have to be given; whether to send the best matches of any type; the storefront to ask in; and what to send beside the results.
Returns
What Apple answered: the results by type under results, each a first page with a next of its own, and the best matches under results.top when they were asked for.
Throws
TypeError if an argument is not what it should be, before Apple is asked.
Throws
AppleMusicError if Apple, the network, or a token provider fails, if the client has no storefront to ask in, or a schema finds issues; _tag says which.
Throws
The reason options.signal aborted with, when it does.
Throws
Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.