🄲 Spotify

Constructs a new Spotify API client.

#### Parameters:

- credentials – Client credentials to log in
- clientId – Client ID
- clientSecret – Client secret
- redirectUrl? – URL to redirect to

#### Returns:

- Spotify – The newly created client

#### Example:

`js
const client = new Spotify({
clientId: "a-cool-id",
clientSecret: "a-cool-secret",
});
`

---

Properties

$3

readonly string

The client's current access token

---

$3

Browser

The client's Spotify browse API

---

$3

Artists

The client's Spotify artists API

---

$3

Albums

The client's Spotify albums API

---

$3

Tracks

The client's Spotify tracks API

---

$3

Episodes

The client's Spotify episodes API

---

$3

Shows

The client's Spotify shows API

---

Methods

$3

Logs the client in and creates an access token.

#### Parameters:

#### Returns:

- string – The newly created access token

#### Example:

`js
await client.login();
`

---

$3

Searches Spotify using Spotify's search API.

#### Parameters:

- query – Search query
- types – Object types to search for
- options? – Search options
- market? – Market to search within
- limit? – Search results limit
- offset? – Search results offset
- includeExternal? – Include externals in results

#### Returns:

- SearchResponse – Search results

#### Example:

`js
const results = await client.search("Null Magma", ["artist"]);
`

---

$3

Obtains a user from Spotify using an ID.

#### Parameters:

- id – The user's ID

#### Returns:

- PublicUserObject? – User obtained from the user ID, or undefined if no user was found

#### Example:

`js
const user = await client.user("a-cool-id");
`

---

$3

Gets all the markets.

#### Parameters:

#### Returns:

- string[] – All markets

#### Example:

`js
const markets = await client.markets();
`

🄲 Browser

Wrapper for Spotify's browse API.

_private_

---

Methods

$3

Fetches newest releases.

#### Parameters:

- options? – Fetch options
- country? – Country code
- limit? – Fetch limit
- offset? – Fetch offset

#### Returns:

- BrowseNewReleasesResponse – Fetched new releases

#### Example:

`js
const releases = await client.browse.newReleases({
limit: 25,
offset: 25,
});
`

---

$3

Fetches featured playlists.

#### Parameters:

- options? – Fetch options
- country? – Country code
- locale? – Locale
- timestamp? – Timestamp
- limit? – Fetch limit
- offset? – Fetch offset

#### Returns:

- BrowseFeaturedPlaylistsResponse – Fetched featured playlists

#### Example:

`js
const playlists = await client.browse.featuredPlaylists();
`

---

$3

Fetches all categories.

#### Parameters:

- options? – Fetch options
- country? – Country code
- locale? – Locale
- limit? – Fetch limit
- offset? – Fetch offset

#### Returns:

- BrowseAllCategoriesResponse – Fetched categories

#### Example:

`js
const categories = await client.browse.allCategories();
`

---

$3

Fetches a category.

#### Parameters:

- category – The category
- options? – Fetch options
- country? – Country code
- locale? – Locale

#### Returns:

- BrowseCategoryResponse – Fetched categories

#### Example:

`js
const category = await client.browse.category("party");
`

---

$3

Fetches a category's playlists.

#### Parameters:

- category – The category
- options? – Fetch options
- country? – Country code
- limit? – Fetch limit
- offset? – Fetch offset

#### Returns:

- PagingObject – Fetched playlists

#### Example:

`js
const playlists = await client.browse.categoryPlaylists("party");
`

---

$3

Fetches a category's playlists.

#### Parameters:

- seeds – Seeds
- artists – Seed artists
- genres – Seed genres
- tracks - Seed tracks
- options? – Fetch options
- _Not available_

#### Returns:

- BrowseRecommendationsResponse – Fetched category platlists

#### Example:

_Not available_

---

$3

Fetches recommendation genres.

#### Parameters:

#### Returns:

- string[] – Fetched genres

#### Example:

`js
const genres = await client.browse.recommendationGenres();
`

🄲 Artists

Wrapper for Spotify's artists API.

_private_

---

Methods

$3

Retrieves an artist or multiple artists.

#### Parameters:

- ids – Can either be an ID or array of IDs.

#### Returns:

_If a single ID is used:_

- ArtistsSingleArtistResponse – The artist retrieved

_If an array of IDs is used:_

- ArtistsMultipleArtistsResponse – The artists retrieved

#### Example:

`js
const artists = await client.artists.get(["a-id", "another-id"]);
`

---

$3

Retrieves an artist's top tracks.

#### Parameters:

- id – Artist ID

#### Returns:

- ArtistsTopTracksResponse – The artist's top tracks

#### Example:

`js
const topTracks = await client.artists.topTracks("an-id");
`

---

$3

Retrieves an artist's related artists.

#### Parameters:

- id – Artist ID

#### Returns:

- ArtistsRelatedArtistsResponse – The artist's related artists

#### Example:

`js
const related = await client.artists.related("an-id");
`

---

$3

Retrieves an artist's albums.

#### Parameters:

- id – Artist ID

#### Returns:

- ArtistsAlbumsResponse – The artist's albums

#### Example:

`js
const albums = await client.artists.albums("an-id");
`

🄲 Shows

Wrapper for Spotify's shows API.

_private_

---

Methods

$3

Retrieves an album or multiple albums.

#### Parameters:

- ids – Can either be an ID or array of IDs.
- options? – Fetch options
- market? – Country code

#### Returns:

_If a single ID is used:_

- AlbumsSingleAlbumResponse – The album retrieved

_If an array of IDs is used:_

- AlbumsMultipleAlbumsResponse – The albums retrieved

#### Example:

`js
const albums = await client.albums.get(["an-id", "another-id"]);
`

---

$3

Retrieves an album's tracks.

#### Parameters:

- id – The album's ID
- options? – Fetch options
- market – Country code
- limit – Fetch limit
- offset – Fetch offset

#### Returns:

- AlbumsTracksResponse – The album's tracks

#### Example:

`js
const tracks = await client.albums.tracks("an-id");
`

🄲 Tracks

Wrapper for Spotify's tracks API.

_private_

---

Methods

$3

Retrieves a track or multiple tracks.

#### Parameters:

- ids – Can either be an ID or array of IDs.
- options? – Fetch options
- market? – Country code

#### Returns:

_If a single ID is used:_

- TracksSingleTrackResponse – The track retrieved

_If an array of IDs is used:_

- TracksMultipleTracksResponse – The tracks retrieved

---

$3

Retrieves a track or multiple tracks' audio features.

#### Parameters:

- ids – Can either be an ID or array of IDs.
- options? – Fetch options
- market? – Country code

#### Returns:

_If a single ID is used:_

- TracksSingleTrackAudioFeatureResponse – The audio feature retrieved

_If an array of IDs is used:_

- TracksMultipleTracksAudioFeaturesResponse – The audio features retrieved

$3

Retrieves a track's audio analysis

#### Parameters:

- id – Track ID

#### Returns:

- AudioAnalysisObject – The audio analysis

🄲 Episodes

Wrapper for Spotify's episodes API.

_private_

---

Methods

$3

Retrieves an episode or multiple episodes.

#### Parameters:

- ids – Can either be an ID or array of IDs.
- options? – Fetch options
- market? – Country code

#### Returns:

_If a single ID is used:_

- EpisodesSingleEpisodeResponse – The episode retrieved

_If an array of IDs is used:_

- EpisodesMultipleEpisodesResponse – The episodes retrieved

🄲 Shows

Wrapper for Spotify's shows API.

_private_

---

Methods

$3

Retrieves a show or multiple shows.

#### Parameters:

- ids – Can either be an ID or array of IDs.
- options? – Fetch options
- market? – Country code

#### Returns:

_If a single ID is used:_

- ShowsSingleShowResponse – The show retrieved

_If an array of IDs is used:_

- ShowsMultipleShowsResponse – The shows retrieved

#### Example:

`js
const shows = await client.shows.get(["an-id", "another-id"]);
`

---

$3

Retrieves a show's episodes.

#### Parameters:

- id – The show's ID

#### Returns:

- ShowsEpisodesResponse – The episodes retrieved

#### Example:

`js
const episodes = await client.shows.episodes("an-id");
``