Array of IDs.
+Optionaloptions: PagingOptions & { Optionaloptions: PagingOptions & { Optionaloptions: PagingOptions & { Optionaloptions: PagingOptions & { Optionaloptions: PagingOptions & { Returns a promise with an array of Albums.
+Optionaloptions: PagingOptions & { Returns a promise with an array of Albums.
Optionalmarket: MarketsAn ISO 3166-1 alpha-2 country code. +
Optionalmarket: MarketsAn ISO 3166-1 alpha-2 country code. If a country code is specified, only episodes that are available in that market will be returned. If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter. Note: If neither market or user country are provided, the content is considered unavailable for the client.
Returns a promise with an array of Tracks.
The ID of the track.
+The ID of the track.
Returns a promise with a AudioAnalysis.
The ID of the track.
+The ID of the track.
Returns a promise with a AudioFeatures.
The IDs of the tracks.
+The IDs of the tracks.
Returns a promise with a AudioFeatures.
OptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackThe slug to get.
-Optionaloptions: { Options.
+The slug to post.
-AbstractReturns a promise with the current playback state.
+Returns a promise with the current playback state.
Optionaloptions: { Optionallimit?: numberOptionaloffset?: numberOptionaloptions: { Optionalafter?: numberOptionalbefore?: numberOptionallimit?: numberReturns a promise with the RecentlyPlayed items.
+Optionaloptions: { Optionallimit?: numberOptionaloffset?: numberOptionaloptions: { Optionalafter?: numberOptionalbefore?: numberOptionallimit?: numberReturns a promise with the RecentlyPlayed items.
Array of IDs.
+Returns a promise with the an array of booleans.
+Returns a promise with the an array of booleans.
Optionaloptions: TopOptionsReturns a promise with the paginated Artist.
+Optionaloptions: TopOptionsReturns a promise with the paginated Artist.
Optionaloptions: TopOptionsReturns a promise with the paginated Track.
+Optionaloptions: TopOptionsReturns a promise with the paginated Track.
Optionalstack: stringOptionalstack: stringOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackReadonlycauseOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackThe query you want to search for.
+The query you want to search for.
The search options.
Returns a promise with all the SearchItems.
The ID of the track.
+Optionaldata?: Record<string, unknown>Optionalstack?: stringOptionaldata?: Record<string, unknown>Optionalstack?: stringOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackThe ID of the user.
+The ID of the user.
Returns a promise with the UserPublic.
The type of the album.
-The artists of the album.
-The markets in which the album is available: ISO 3166-1 alpha-2 country codes. +
The artists of the album.
+The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.
-The copyright statements of the album.
-Optionalexternal_Known external IDs for the track.
-Known external URLs for this album.
-The genres of the album.
-A link to the Web API endpoint providing full details of the album.
-The Spotify ID for the album.
-The cover art for the album in various sizes, widest first.
-The label for the album.
-OptionalnameThe name of the album. +
The copyright statements of the album.
+Optionalexternal_Known external IDs for the track.
+Known external URLs for this album.
+The genres of the album.
+A link to the Web API endpoint providing full details of the album.
+The Spotify ID for the album.
+The cover art for the album in various sizes, widest first.
+The label for the album.
+OptionalnameThe name of the album. In case of an album takedown, the value may be an empty string.
-The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
-The date the album was first released.
-The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
+The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
+The date the album was first released.
+The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content.
-The number of tracks in the album.
-The tracks of the album.
-The object type.
-The Spotify URI for the album.
-The number of tracks in the album.
+The tracks of the album.
+The object type.
+The Spotify URI for the album.
+The type of the album.
-The markets in which the album is available: ISO 3166-1 alpha-2 country codes. +
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.
-The copyright statements of the album.
-Optionalexternal_Known external IDs for the track.
-Known external URLs for this album.
-The genres of the album.
-A link to the Web API endpoint providing full details of the album.
-The Spotify ID for the album.
-The cover art for the album in various sizes, widest first.
-The label for the album.
-OptionalnameThe name of the album. +
The copyright statements of the album.
+Optionalexternal_Known external IDs for the track.
+Known external URLs for this album.
+The genres of the album.
+A link to the Web API endpoint providing full details of the album.
+The Spotify ID for the album.
+The cover art for the album in various sizes, widest first.
+The label for the album.
+OptionalnameThe name of the album. In case of an album takedown, the value may be an empty string.
-The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
-The date the album was first released.
-The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
+The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
+The date the album was first released.
+The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content.
-The number of tracks in the album.
-The object type.
-The Spotify URI for the album.
-The number of tracks in the album.
+The object type.
+The Spotify URI for the album.
+Optionalalbum_The field is present when getting an artist's albums. Compare to album_type this field represents relationship between the artist and the album.
-The type of the album.
-The artists of the album.
-The markets in which the album is available: ISO 3166-1 alpha-2 country codes. +
The type of the album.
+The artists of the album.
+The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.
-The copyright statements of the album.
-Optionalexternal_Known external IDs for the track.
-Known external URLs for this album.
-The genres of the album.
-A link to the Web API endpoint providing full details of the album.
-The Spotify ID for the album.
-The cover art for the album in various sizes, widest first.
-The label for the album.
-OptionalnameThe name of the album. +
The copyright statements of the album.
+Optionalexternal_Known external IDs for the track.
+Known external URLs for this album.
+The genres of the album.
+A link to the Web API endpoint providing full details of the album.
+The Spotify ID for the album.
+The cover art for the album in various sizes, widest first.
+The label for the album.
+OptionalnameThe name of the album. In case of an album takedown, the value may be an empty string.
-The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
-The date the album was first released.
-The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
+The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
+The date the album was first released.
+The precision with which release_date value is known.
OptionalrestrictionsIncluded in the response when a content restriction is applied.
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content.
-The number of tracks in the album.
-The object type.
-The Spotify URI for the album.
-The number of tracks in the album.
+The object type.
+The Spotify URI for the album.
+A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0 represents high confidence the track is acoustic.
-A URL to access the full audio analysis of this track. An access token is required to access this data.
-Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. +
A URL to access the full audio analysis of this track. An access token is required to access this data.
+Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. A value of 0.0 is least danceable and 1.0 is most danceable.
-The duration of the track in milliseconds.
-Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. +
The duration of the track in milliseconds.
+Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. Typically, energetic tracks feel fast, loud, and noisy. For example, death metal has high energy, while a Bach prelude scores low on the scale. Perceptual features contributing to this attribute include dynamic range, perceived loudness, timbre, onset rate, and general entropy.
-The Spotify ID for the track.
-Predicts whether a track contains no vocals. "Ooh" and "aah" sounds are treated as instrumental in this context. +
The Spotify ID for the track.
+Predicts whether a track contains no vocals. "Ooh" and "aah" sounds are treated as instrumental in this context. Rap or spoken word tracks are clearly "vocal". The closer the instrumentalness value is to 1.0, the greater likelihood the track contains no vocal content. Values above 0.5 are intended to represent instrumental tracks, but confidence is higher as the value approaches 1.0.
-The key the track is in. Integers map to pitches using standard Pitch Class notation. +
The key the track is in. Integers map to pitches using standard Pitch Class notation. E.g. 0 = C, 1 = C♯/D♭, 2 = D, and so on.
-Detects the presence of an audience in the recording. Higher liveness values represent an increased probability that the track was performed live. +
Detects the presence of an audience in the recording. Higher liveness values represent an increased probability that the track was performed live. A value above 0.8 provides strong likelihood that the track is live.
-The overall loudness of a track in decibels (dB). Loudness values are averaged across the entire track and are useful for comparing relative loudness of tracks. +
The overall loudness of a track in decibels (dB). Loudness values are averaged across the entire track and are useful for comparing relative loudness of tracks. Loudness is the quality of a sound that is the primary psychological correlate of physical strength (amplitude). Values typical range between -60 and 0 db.
-Mode indicates the modality (major or minor) of a track, the type of scale from which its melodic content is derived. +
Mode indicates the modality (major or minor) of a track, the type of scale from which its melodic content is derived. Major is represented by 1 and minor is 0.
-Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. Talk show, audio book, poetry), the closer to 1.0 the attribute value. +
Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. Talk show, audio book, poetry), the closer to 1.0 the attribute value. Values above 0.66 describe tracks that are probably made entirely of spoken words. Values between 0.33 and 0.66 describe tracks that may contain both music and speech, either in sections or layered, including such cases as rap music. Values below 0.33 most likely represent music and other non-speech-like tracks.
-The overall estimated tempo of a track in beats per minute (BPM). In musical terminology, tempo is the speed or pace of a given piece and derives directly from the average beat duration.
-An estimated overall time signature of a track. The time signature (meter) is a notational convention to specify how many beats are in each bar (or measure).
-A link to the Web API endpoint providing full details of the track.
-The object type.
-The Spotify URI for the track.
-A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. Tracks with high valence sound more positive (e.g. Happy, cheerful, euphoric), while tracks with low valence sound more negative (e.g. Sad, depressed, angry).
-The overall estimated tempo of a track in beats per minute (BPM). In musical terminology, tempo is the speed or pace of a given piece and derives directly from the average beat duration.
+An estimated overall time signature of a track. The time signature (meter) is a notational convention to specify how many beats are in each bar (or measure).
+A link to the Web API endpoint providing full details of the track.
+The object type.
+The Spotify URI for the track.
+A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. Tracks with high valence sound more positive (e.g. Happy, cheerful, euphoric), while tracks with low valence sound more negative (e.g. Sad, depressed, angry).
+International Article Number (http://en.wikipedia.org/wiki/International_Article_Number_(EAN)).
-International Standard Recording Code (https://en.wikipedia.org/wiki/International_Standard_Recording_Code).
-Universal Product Code (http://en.wikipedia.org/wiki/Universal_Product_Code).
-International Standard Recording Code (https://en.wikipedia.org/wiki/International_Standard_Recording_Code).
+Universal Product Code (http://en.wikipedia.org/wiki/Universal_Product_Code).
+OptionaloffsetThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.
+OptionallimitMaximum number of results to return. Minimum: 1. Maximum: 100. Default: 20. Note: The limit is applied within each type, not on the total response.
-OptionalmarketAn ISO 3166-1 alpha-2 country code or the string from_token.
+
OptionalmarketAn ISO 3166-1 alpha-2 country code or the string from_token.
If market is set to from_token, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned.
Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalseed_Optionalseed_Optionalseed_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmax_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalmin_Optionalseed_Optionalseed_Optionalseed_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_Optionaltarget_List of item types to search across.
-OptionalincludeIf include_external is specified the response will include any relevant audio content that is hosted externally. +
OptionalincludeIf include_external is specified the response will include any relevant audio content that is hosted externally. By default external content is filtered out from responses.
-OptionallimitMaximum number of results to return. +
OptionallimitMaximum number of results to return. Minimum: 1. Maximum: 50. Default: 20. Note: The limit is applied within each type, not on the total response.
-OptionalmarketAn ISO 3166-1 alpha-2 country code or the string from_token.
+
OptionalmarketAn ISO 3166-1 alpha-2 country code or the string from_token.
If market is set to from_token, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned.
OptionaloffsetThe index of the first result to return. +
OptionaloffsetThe index of the first result to return. Maximum: 1000. Default: 0.
-OptionalacccessOptionalaccessOptionalclientOptionaldebugEnable debug mode.
-OptionalhttpHTTP options.
+OptionalaccessOptionalclientOptionaldebugEnable debug mode.
+OptionalhttpHTTP options.
OptionalbaseURL?: stringBase URL for the API. Default: "https://api.spotify.com".
Optionalheaders?: Record<string, string>Set headers to be sent with every request.
OptionallocalChange the default outbind IP (can be IPV6 or IPV4).
Optionalproxy?: AxiosProxyConfigHTTP proxy config.
OptionaluserSet a custom user agent. Default: "spotify.js/
OptionallogLog retries.
-OptionalrefreshOptionalretryRetry request when ratelimit is hit.
-Optionalretry5xxRetry request if the response code is in the 500 range. Default: true
-Optionalretry5xxAmount of retries. Default: 3
-OptionallogLog retries.
+OptionalrefreshOptionalretryRetry request when ratelimit is hit.
+Optionalretry5xxRetry request if the response code is in the 500 range. Default: true
+Optionalretry5xxAmount of retries. Default: 3
+OptionallimitThe number of entities to return. Default: 20. Minimum: 1. Maximum: 50.
-OptionaloffsetThe index of the first entity to return. Default: 0 (i.e., the first track). +
OptionaloffsetThe index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.
-OptionaltimeOver what time frame the affinities are computed. +
OptionaltimeOver what time frame the affinities are computed.
Valid values:
long_term (calculated from several years of data and including all new data as it becomes available),
medium_term (approximately last 6 months),
short_term (approximately last 4 weeks).
Default: medium_term.
The album on which the track appears.
-The artists who performed the track.
-The markets in which the album is available: ISO 3166-1 alpha-2 country codes. +
The artists who performed the track.
+The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.
-The disc number (usually 1 unless the album consists of more than one disc).
-The track length in milliseconds.
-Whether or not the track has explicit lyrics.
-Known external IDs for the track.
-Known external URLs for this track.
-A link to the Web API endpoint providing full details of the track.
-The Spotify ID for the track.
-Whether or not the track is from a local file.
-Optionalis_Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
-Optionallinked_Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
-Name of the track.
-The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
-A link to a 30 second preview (MP3 format) of the track.
-OptionalrestrictionsIncluded in the response when a content restriction is applied.
-The number of the track. If an album has several discs, the track number is the number on the specified disc.
-The object type: "track".
-The Spotify URI for the track.
-The disc number (usually 1 unless the album consists of more than one disc).
+The track length in milliseconds.
+Whether or not the track has explicit lyrics.
+Known external IDs for the track.
+Known external URLs for this track.
+A link to the Web API endpoint providing full details of the track.
+The Spotify ID for the track.
+Whether or not the track is from a local file.
+Optionalis_Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
+Optionallinked_Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
+Name of the track.
+The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
+A link to a 30 second preview (MP3 format) of the track.
+OptionalrestrictionsIncluded in the response when a content restriction is applied.
+The number of the track. If an album has several discs, the track number is the number on the specified disc.
+The object type: "track".
+The Spotify URI for the track.
+The artists who performed the track.
-The markets in which the album is available: ISO 3166-1 alpha-2 country codes. +
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. Note that an album is considered available in a market when at least 1 of its tracks is available in that market.
-The disc number (usually 1 unless the album consists of more than one disc).
-The track length in milliseconds.
-Whether or not the track has explicit lyrics.
-Known external URLs for this track.
-A link to the Web API endpoint providing full details of the track.
-The Spotify ID for the track.
-Whether or not the track is from a local file.
-Optionalis_Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
-Optionallinked_Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
-Name of the track.
-A link to a 30 second preview (MP3 format) of the track.
-OptionalrestrictionsIncluded in the response when a content restriction is applied.
-The number of the track. If an album has several discs, the track number is the number on the specified disc.
-The object type: "track".
-The Spotify URI for the track.
-The disc number (usually 1 unless the album consists of more than one disc).
+The track length in milliseconds.
+Whether or not the track has explicit lyrics.
+Known external URLs for this track.
+A link to the Web API endpoint providing full details of the track.
+The Spotify ID for the track.
+Whether or not the track is from a local file.
+Optionalis_Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
+Optionallinked_Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
+Name of the track.
+A link to a 30 second preview (MP3 format) of the track.
+OptionalrestrictionsIncluded in the response when a content restriction is applied.
+The number of the track. If an album has several discs, the track number is the number on the specified disc.
+The object type: "track".
+The Spotify URI for the track.
+
The ID of the album.
+