Skip to main content

Class: AppleMusic

Defined in: AppleMusic.ts:32

High-level Apple Music API client composed of typed endpoint helpers.

Remarks​

The client lazily instantiates every endpoint and shares a common configuration and authenticated Axios instance. You must call init() before accessing any endpoint methods.

Example​

const client = new AppleMusic({ region: Region.US });
await client.init();

const album = await client.Albums.get({ id: "310730204" });
console.log(album.data[0].attributes?.name);

Accessors​

log​

Get Signature​

get log(): Logger;

Defined in: AppleMusic.ts:81

Structured logger propagated to every endpoint.

Returns​

Logger

Set Signature​

set log(logger: Logger): void;

Defined in: AppleMusic.ts:88

Replace the underlying logger at runtime.

Parameters​
ParameterType
loggerLogger
Returns​

void

Constructors​

Constructor​

new AppleMusic(config?: 
  | AppleMusicConfigParams
  | AppleMusicConfig): AppleMusic;

Defined in: AppleMusic.ts:102

Create a new Apple Music client.

Parameters​

ParameterTypeDescription
config?| AppleMusicConfigParams | AppleMusicConfigOptional configuration object or instance to seed the client.

Returns​

AppleMusic

Endpoints​

readonly Search: SearchEndpoint;

Defined in: AppleMusic.ts:40

Search endpoint for performing search queries across the Apple Music catalog.

Suggestions​

readonly Suggestions: SuggestionsEndpoint;

Defined in: AppleMusic.ts:46

Suggestions endpoint for retrieving search term suggestions.

Hints​

readonly Hints: HintsEndpoint;

Defined in: AppleMusic.ts:52

Hints endpoint for retrieving search hints.

Albums​

readonly Albums: AlbumsEndpoint;

Defined in: AppleMusic.ts:58

Albums endpoint for album-related operations.

Songs​

readonly Songs: SongsEndpoint;

Defined in: AppleMusic.ts:64

Songs endpoint for song-related operations.

Artists​

readonly Artists: ArtistsEndpoint;

Defined in: AppleMusic.ts:70

Artists endpoint for artist-related operations.

MusicVideos​

readonly MusicVideos: MusicVideosEndpoint;

Defined in: AppleMusic.ts:76

Music Videos endpoint for music video operations.

Methods​

init()​

init(): Promise<void>;

Defined in: AppleMusic.ts:143

Authenticate with Apple Music and prepare every endpoint for use.

Returns​

Promise<void>

Remarks​

This method is idempotent. Repeated calls reuse the same configuration and reinitialize each endpoint. All endpoint accessors throw until initialization succeeds.

Throws​

Error If authentication fails.

verifyTokenValidity()​

verifyTokenValidity(): Promise<boolean>;

Defined in: AppleMusic.ts:191

Perform a lightweight request to validate the configured developer token.

Returns​

Promise<boolean>

Whether the token is currently accepted by Apple Music.

Properties​

config​

config: AppleMusicConfig;

Defined in: AppleMusic.ts:95

Mutable configuration backing this client instance.