Skip to main content

Getting Started with Spotify Web API

Introduction

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 OAuth 2.0.

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

Need help? See our Web API guides for more information, or visit the Spotify for Developers community forum to ask questions and connect with other developers.

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install spotify-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/spotify-api-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
authorization_code_auth_credentials AuthorizationCodeAuthCredentials The credential object for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

client = SpotifywebapiClient(
    authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_redirect_uri='OAuthRedirectUri',
        o_auth_scopes=[
            OAuthScopeEnum.APP_REMOTE_CONTROL,
            OAuthScopeEnum.PLAYLIST_READ_PRIVATE
        ]
    )
)

API calls return an ApiResponse object that includes the following fields:

Field Description
status_code Status code of the HTTP response
reason_phrase Reason phrase of the HTTP response
headers Headers of the HTTP response as a dictionary
text The body of the HTTP response as a string
request HTTP request info
errors Errors, if they exist
body The deserialized body of the HTTP response

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Metadata

Release files for spotify-api-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spotify-api-sdk 1.0.0
File Size Uploaded Provenance Actions
spotify_api_sdk-1.0.0.tar.gz 81.1 kB Without provenance Details for spotify_api_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spotify-api-sdk 1.0.0
File Interpreter ABI Platform Actions
spotify_api_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for spotify_api_sdk-1.0.0-py3-none-any.whl

Total release size: 312.9 kB

Release files / spotify_api_sdk-1.0.0.tar.gz

Download URL spotify_api_sdk-1.0.0.tar.gz
Size 81.1 kB
Tags Source
SHA-256 checksum
How to use checksums
af5567738ab9d86571a8ecc23276010bd3867d20731e38fb3a8f29e9fc793337
BLAKE2b-256 checksum
How to use checksums
4963ec8222da27b8436ac6e5aca28dbfe609c940d8ce19c817641cce2e2bfc4a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.13

Release files / spotify_api_sdk-1.0.0-py3-none-any.whl

Download URL spotify_api_sdk-1.0.0-py3-none-any.whl
Size 231.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b915579f31aa661d984d1eb69e8a894713008b62da1afc6274c0ca6f3f74b80c
BLAKE2b-256 checksum
How to use checksums
3bf473340babb013f3ab30750caaf13ef570deb326d4540b67951393a2742893
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.13

Security for spotify-api-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page