Skip to content
DocumentationAPI Reference
API Reference

API Reference

Libraries

npm install spotted-ts
pip install spotted
implementation("dev.cjav.spotted:spotted-java:0.0.1")
implementation("dev.cjav.spotted:spotted-kotlin:0.0.1")
go get -u 'github.com/cjavdev/[email protected]'
gem "spotted"
<!-- x-release-please-start-version -->

## Installation

### Installing with Homebrew

~~~sh
brew tap cjavdev/spotted-cli
brew install spotted
~~~

### Installing with Go

~~~sh
go install 'github.com/cjavdev/spotted-cli/cmd/spotted@latest'
~~~

<!-- x-release-please-end -->
dotnet add package Spotted

API Overview

Albums

Get Album
GET/albums/{id}
Get Album Tracks
GET/albums/{id}/tracks

Artists

Get Artist
GET/artists/{id}
Get Artist's Albums
GET/artists/{id}/albums
Get Artist's Top Tracks
GET/artists/{id}/top-tracks
Get Artist's Related Artists
Deprecated
GET/artists/{id}/related-artists

Shows

Get Show
GET/shows/{id}
Get Show Episodes
GET/shows/{id}/episodes

Episodes

Get Episode
GET/episodes/{id}

Audiobooks

Get an Audiobook
GET/audiobooks/{id}
Get Audiobook Chapters
GET/audiobooks/{id}/chapters

MeAudiobooks

MePlaylists

MeTop

Get User's Top Tracks
GET/me/top/tracks
Get User's Top Artists
GET/me/top/artists

MeAlbums

MeTracks

MeEpisodes

MeFollowing

Get Followed Artists
GET/me/following
Follow Artists or Users
PUT/me/following
Unfollow Artists or Users
DELETE/me/following

MePlayer

Get Playback State
GET/me/player
Transfer Playback
PUT/me/player
Get Available Devices
GET/me/player/devices
Get Currently Playing Track
GET/me/player/currently-playing
Start/Resume Playback
PUT/me/player/play
Pause Playback
PUT/me/player/pause
Skip To Next
POST/me/player/next
Skip To Previous
POST/me/player/previous
Seek To Position
PUT/me/player/seek
Set Repeat Mode
PUT/me/player/repeat
Set Playback Volume
PUT/me/player/volume
Toggle Playback Shuffle
PUT/me/player/shuffle
Get Recently Played Tracks
GET/me/player/recently-played

MePlayerQueue

Get the User's Queue
GET/me/player/queue
Add Item to Playback Queue
POST/me/player/queue

Chapters

Get a Chapter
GET/chapters/{id}

Tracks

Get Track
GET/tracks/{id}

Playlists

Get Playlist
GET/playlists/{playlist_id}
Change Playlist Details
PUT/playlists/{playlist_id}

PlaylistsTracks

Get Playlist Items
GET/playlists/{playlist_id}/tracks
Add Items to Playlist
POST/playlists/{playlist_id}/tracks
Update Playlist Items
PUT/playlists/{playlist_id}/tracks
Remove Playlist Items
DELETE/playlists/{playlist_id}/tracks

PlaylistsFollowers

Follow Playlist
PUT/playlists/{playlist_id}/followers
Unfollow Playlist
DELETE/playlists/{playlist_id}/followers
Check if Current User Follows Playlist
GET/playlists/{playlist_id}/followers/contains

PlaylistsImages

Get Playlist Cover Image
GET/playlists/{playlist_id}/images
Add Custom Playlist Cover Image
PUT/playlists/{playlist_id}/images

Users

Get User's Profile
GET/users/{user_id}

UsersPlaylists

Get User's Playlists
GET/users/{user_id}/playlists
Create Playlist
POST/users/{user_id}/playlists

Browse

Get Featured Playlists
Deprecated
GET/browse/featured-playlists
Get New Releases
GET/browse/new-releases

BrowseCategories

Get Several Browse Categories
GET/browse/categories
Get Single Browse Category
GET/browse/categories/{category_id}
Get Category's Playlists
Deprecated
GET/browse/categories/{category_id}/playlists

Audio Features

Get Several Tracks' Audio Features
Deprecated
GET/audio-features
Get Track's Audio Features
Deprecated
GET/audio-features/{id}

Audio Analysis

Get Track's Audio Analysis
Deprecated
GET/audio-analysis/{id}

Recommendations

Get Recommendations
Deprecated
GET/recommendations
Get Available Genre Seeds
Deprecated
GET/recommendations/available-genre-seeds

Markets