Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AlbumsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private http

http: Http

Methods

getAlbum

  • Get Spotify catalog information for a single album.

    Required Scopes: None.

    example
    const album = await spotify.albums.getAlbum('53VKICyqCf91sVkTdFrzKX');
    console.log(album.name);
    // "Titanic Rising"

    Parameters

    • albumId: string

      The Spotify ID for the album.

    • Optional options: MarketOptions

      Optional request information.

    Returns Promise<Album>

getAlbumTracks

  • Get Spotify catalog information about an album's tracks.

    Required Scopes: None.

    example
    const tracks = await spotify.albums.getAlbumTracks('76254F4WYdKOm0pVAVvp0x');
    console.log(tracks.items.map(track => track.name));
    // Array [ "4D", "MTI" ]

    Parameters

    • albumId: string

      The Spotify ID for the album.

    • Optional options: GetAlbumTracksOptions

      Optional request information.

    Returns Promise<GetAlbumTracksResponse>

getAlbums

  • Get Spotify catalog information for multiple albums identified by their Spotify IDs.

    Required Scopes: None.

    example
    const albums = await spotify.albums.getAlbums([
      '0FO3N0KhhvXY7SORYneGbw',
      '3FND6DpDA79Fox7bv8LvRC',
    ]);
    console.log(albums.map(album => album.name));
    // Array [ "What's There", "Heat Division" ]

    Parameters

    • albumIds: string[]

      The Spotify IDs for the albums.

    • Optional options: MarketOptions

      Optional request information.

    Returns Promise<Array<Album | null>>

Generated using TypeDoc