You can use Spotify's Web API to discover music and podcasts, manage your Spotify library, control audio playback, and much more. Browse our available Web API endpoints using the sidebar at left, or via the navigation bar on top of this page on smaller screens.

In order to make successful Web API requests your app will need a valid access token. One can be obtained through <a href="https://developer.spotify.com/documentation/general/guides/authorization-guide/\">OAuth 2.0.

The base URI for all Web API requests is https://api.spotify.com/v1.

Need help? See our <a href="https://developer.spotify.com/documentation/web-api/guides/\">Web API guides for more information, or visit the <a href="https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer\">Spotify for Developers community forum to ask questions and connect with other developers.

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.5.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/viqueen/spotify-api-go-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

All URIs are relative to https://api.spotify.com/v1

• AddTracksToPlaylistRequest
• AlbumBase
• AlbumObject
• AlbumRestrictionObject
• ArtistDiscographyAlbumObject
• ArtistObject
• AudioAnalysisObject
• AudioAnalysisObjectMeta
• AudioAnalysisObjectTrack
• AudioFeaturesObject
• AudiobookBase
• AudiobookObject
• AuthorObject
• CategoryObject
• ChangePlaylistDetailsRequest
• ChapterBase
• ChapterObject
• ChapterRestrictionObject
• ContextObject
• CopyrightObject
• CreatePlaylistRequest
• CurrentlyPlayingContextObject
• CursorObject
• CursorPagingObject
• CursorPagingPlayHistoryObject
• CursorPagingSimplifiedArtistObject
• DeviceObject
• DisallowsObject
• EpisodeBase
• EpisodeObject
• EpisodeRestrictionObject
• ErrorObject
• ExplicitContentSettingsObject
• ExternalIdObject
• ExternalUrlObject
• FollowArtistsUsersRequest
• FollowPlaylistRequest
• FollowersObject
• GetAUsersAvailableDevices200Response
• GetAnAlbum401Response
• GetAnArtistsTopTracks200Response
• GetAvailableMarkets200Response
• GetCategories200Response
• GetCategories200ResponseCategories
• GetFollowed200Response
• GetMultipleAlbums200Response
• GetMultipleArtists200Response
• GetMultipleAudiobooks200Response
• GetMultipleEpisodes200Response
• GetMultipleShows200Response
• GetNewReleases200Response
• GetRecommendationGenres200Response
• GetSeveralAudioFeatures200Response
• GetSeveralChapters200Response
• GetUsersTopArtistsAndTracks200Response
• GetUsersTopArtistsAndTracks200ResponseAllOfItemsInner
• ImageObject
• LinkedTrackObject
• NarratorObject
• PagingArtistDiscographyAlbumObject
• PagingArtistObject
• PagingFeaturedPlaylistObject
• PagingObject
• PagingPlaylistObject
• PagingPlaylistTrackObject
• PagingSavedAlbumObject
• PagingSavedEpisodeObject
• PagingSavedShowObject
• PagingSavedTrackObject
• PagingSimplifiedAlbumObject
• PagingSimplifiedAudiobookObject
• PagingSimplifiedChapterObject
• PagingSimplifiedEpisodeObject
• PagingSimplifiedShowObject
• PagingSimplifiedTrackObject
• PagingTrackObject
• PlayHistoryObject
• PlaylistObject
• PlaylistOwnerObject
• PlaylistTrackObject
• PlaylistTrackObjectTrack
• PlaylistTracksRefObject
• PlaylistUserObject
• PrivateUserObject
• PublicUserObject
• QueueObject
• QueueObjectCurrentlyPlaying
• QueueObjectQueueInner
• RecommendationSeedObject
• RecommendationsObject
• RemoveEpisodesUserRequest
• RemoveTracksPlaylistRequest
• RemoveTracksPlaylistRequestTracksInner
• ReorderOrReplacePlaylistsTracks200Response
• ReorderOrReplacePlaylistsTracksRequest
• ResumePointObject
• SaveAlbumsUserRequest
• SaveEpisodesUserRequest
• SaveTracksUserRequest
• SavedAlbumObject
• SavedEpisodeObject
• SavedShowObject
• SavedTrackObject
• Search200Response
• SectionObject
• SegmentObject
• ShowBase
• ShowObject
• SimplifiedAlbumObject
• SimplifiedArtistObject
• SimplifiedAudiobookObject
• SimplifiedChapterObject
• SimplifiedEpisodeObject
• SimplifiedPlaylistObject
• SimplifiedShowObject
• SimplifiedTrackObject
• StartAUsersPlaybackRequest
• TimeIntervalObject
• TrackObject
• TrackRestrictionObject
• TransferAUsersPlaybackRequest
• UnfollowArtistsUsersRequest

Authentication schemes defined for the API:

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://accounts.spotify.com/authorize
• Scopes:
• app-remote-control: Communicate with the Spotify app on your device.
• playlist-read-private: Access your private playlists.
• playlist-read-collaborative: Access your collaborative playlists.
• playlist-modify-public: Manage your public playlists.
• playlist-modify-private: Manage your private playlists.
• user-library-read: Access your saved content.
• user-library-modify: Manage your saved content.
• user-read-private: Access your subscription details.
• user-read-email: Get your real email address.
• user-follow-read: Access your followers and who you are following.
• user-follow-modify: Manage your saved content.
• user-top-read: Read your top artists and content.
• user-read-playback-position: Read your position in content you have played.
• user-read-playback-state: Read your currently playing content and Spotify Connect devices information.
• user-read-recently-played: Access your recently played items.
• user-read-currently-playing: Read your currently playing content.
• user-modify-playback-state: Control playback on your Spotify clients and Spotify Connect devices.
• ugc-image-upload: Upload images to Spotify on your behalf.
• streaming: Play content and control playback on your other devices.

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, openapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime