Skip to content
Client
Server

Reference / @open-music-sdk/client-catalog / getArtist

Function: getArtist() ​

ts
function getArtist(
   client, 
   id, 
   options?
): Promise<tArtistsResponse>;

Defined in: clients/client-catalog/src/resources.ts:351

The artist with an id.

Parameters ​

client ​

tAppleMusicClient

The client to ask with.

id ​

string

The artist's id.

options? ​

tEndpointOptions<tArtistsResponse, tStorefrontOption, tViewsOption<tArtistViews>>

The storefront to ask in, the views to send with the artist, and what else to send beside it.

Returns ​

Promise<tArtistsResponse>

What Apple answered: the artist under data.

Throws ​

TypeError if client is no client or 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.

MIT licensed. Not affiliated with, endorsed by, or sponsored by Apple Inc. Apple Music and MusicKit are trademarks of Apple Inc.