1. Home
  2. Globals

Type Definitions

Status

Properties
Name Type Attributes Description
status number

The status from the request.
snapshot string <optional>

The playlist's snapshot ID. (applies to playlist changes)
Details
Object

ApiError.js, line 22

CategoryOptions

Properties
Name Type Attributes Default Description
country string <optional>

An ISO 3166-1 alpha-2 country code.
locale string <optional>

The desired language, consisting of an ISO 639-1 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX.
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return.
Details
Object

managers/Categories.js, line 95

ContextURI

Description

Track, album, artist joined with their id by a colon. eg: spotify:album:5ht7ItJgpBH7W6vJ5BqpPr

Details
string

Spotify.js, line 167

LimitOptions

Properties
Name Type Attributes Default Description
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return. Use with limit to get the next set of items.
Details
Object

Spotify.js, line 172

SearchOptions

Properties
Name Type Attributes Default Description
external boolean <optional>
 false

If the client can play externally hosted audio content, and marks the content as playable in the response.
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return. Use with limit to get the next set of items.
Details
Object

Spotify.js, line 178

UserTopOptions

Properties
Name Type Attributes Default Description
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return. Use with limit to get the next set of items.
range TimeRange <optional>
 'medium'

Over what time frame the affinities are computed.
Details
Object

managers/User.js, line 258

FollowingArtistOptions

Properties
Name Type Attributes Default Description
after string <optional>

The last artist ID retrieved from the previous request.
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
Details
Object

managers/User.js, line 265

TimeRange

Description

short - Approximately last 4 weeks medium - Approximately last 6 months long - Calculated from serveral years of data.

Details
string

managers/User.js, line 271

AlbumGroups

Description

The list of groups for an album by default all are supplied.

  • album
  • single
  • appears_on
  • compilation
Details
string

managers/Artist.js, line 301

RecommendedOptions

Properties
Name Type Attributes Default Description
seeds SeedOptions

Recommendations based on the seed options.
max Attributes <optional>

The maximum values of for the attributes.
min Attributes <optional>

The minimum values of for the attributes.
target Attributes <optional>

The target values of for the attributes.
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
Details
Object

managers/Track.js, line 305

ArtistAlbumsOptions

Parameters
Name Type Attributes Default Description
groups Array.<AlbumGroups> <optional>

A list of keywords that will be used to filter the response.
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return. Use with limit to get the next set of items.
Details
Object

managers/Artist.js, line 310

SeedOptions

Properties
Name Type Description
artists Array.<string>

A list of Spotify IDs for seed artists.
genres Array.<string>

A list of any genres in the set of available genre seeds.
tracks Array.<string>

A list of Spotify IDs for a seed track.
Details
Object

managers/Track.js, line 314

Attributes

Description

https://developer.spotify.com/documentation/web-api/reference/#/operations/get-recommendations

Properties
Name Type Description
acousticness number

>= 0 <= 1
danceability number

>= 0 <= 1
duration_ms number
energy number

>= 0 <= 1
instrumentalness number

>= 0 <= 1
key number

>= 0 <= 11
liveness number

>= 0 <= 1
loudness number
mode number

>= 0 <= 1
popularity number

>= 0 <= 100
speachiness number

>= 0 <= 1
temp number
time_signature number
valence number
Details
Object

managers/Track.js, line 321

StartOptions

Properties
Name Type Attributes Default Description
device string <optional>

The device id to start the playback on - by default the current active device.
offset number <optional>
 0

The offset to start the playback.
ms number <optional>
 0

The position to start the playbak in milliseconds.
Details
Object

managers/Player.js, line 539

RecentOptions

Properties
Name Type Attributes Default Description
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
after number <optional>

A Unix timestamp in milliseconds. Returns all items before (but not including) this cursor position.
before number <optional>

A Unix timestamp in milliseconds. Returns all items after (but not including) this cursor position.
Details
Object

managers/Player.js, line 546

AdditionalTypes

Description

Additional types for the client to support - by default 'track' is the suppiled type.

  • track
  • episode
Details
string

managers/Player.js, line 553

RepeatStates

Description

track - will repeat the current track. context - will repeat the current context. off - will turn repeat off.

Details
string

managers/Player.js, line 560

PlaylistOptions

Properties
Name Type Attributes Default Description
types string <optional>
 ['track']

The types that the client supports. (track, episode)
fields string <optional>

Filters for the query, a list of the fields to return. If omitted, all fields are returned.
Details
Object

managers/Playlist.js, line 593

PlaylistTracksOptions

Properties
Name Type Attributes Default Description
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
offset number <optional>
 0

The index of the first item to return.
Details
PlaylistOptions

managers/Playlist.js, line 599

FeaturedOptions

Properties
Name Type Attributes Default Description
limit number <optional>
 20

The maximum number of items to return. Minimum: 1. Maximum: 50.
locale string <optional>

The desired language, consisting of a lowercase ISO 639-1 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX.
offset number <optional>
 0

The index of the first item to return.
timestamp string <optional>

A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time.
Details
Object

managers/Playlist.js, line 605

ModifyOptions

Properties
Name Type Description
name string

The new name for the playlist.
public boolean

If true the playlist will be public, if false it will be private.
collaborative boolean

If true, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client.
description string

Value for playlist description.
Details
Object

managers/Playlist.js, line 613

UpdatePlaylistOptions

Properties
Name Type Attributes Default Description
uris Array.<ContextURI> <optional>

A list of Spotify URIs to set, can be track or episode URIs.
start number <optional>

The position of the first item to be reordered.
before number <optional>

The position where the items should be inserted. To reorder the items to the end of the playlist, simply set insert_before to the position after the last item.
length number <optional>
 1

The amount of items to be reordered.
snapshot string <optional>

The playlist's snapshot ID against which you want to make the changes.
Details
Object

managers/Playlist.js, line 621