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.7+.
Install the package from PyPi using the following pip command:
pip install spotify-apimatic-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/spotify-apimatic-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 | Union[Session, HttpClientProvider] |
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"] |
| proxy_settings | ProxySettings |
Optional proxy configuration to route HTTP requests through a proxy server. |
| authorization_code_auth_credentials | AuthorizationCodeAuthCredentials |
The credential object for OAuth 2 Authorization Code Grant |
The API client can be initialized as follows:
Code-Based Client Initialization
from spotifywebapi.configuration import Environment
from spotifywebapi.http.auth.o_auth_2 import AuthorizationCodeAuthCredentials
from spotifywebapi.models.o_auth_scope_enum import OAuthScopeEnum
from spotifywebapi.spotifywebapi_client import SpotifywebapiClient
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
]
),
environment=Environment.PRODUCTION
)
Environment-Based Client Initialization
from spotifywebapi.spotifywebapi_client import SpotifywebapiClient
# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SpotifywebapiClient.from_environment(dotenv_path='/path/to/.env')
See the Environment-Based Client Initialization section for details.
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Default |
Authorization
This API uses the following authentication schemes.
List of APIs
- Albums
- Artists
- Audiobooks
- Categories
- Chapters
- Episodes
- Genres
- Markets
- Player
- Playlists
- Search
- Shows
- Tracks
- Users
SDK Infrastructure
Configuration
HTTP
Utilities
Metadata
Release files for spotify-apimatic-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)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| spotify_apimatic_sdk-1.0.0.tar.gz | 103.1 kB | Without provenance | Details for spotify_apimatic_sdk-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| spotify_apimatic_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for spotify_apimatic_sdk-1.0.0-py3-none-any.whl |
Total release size: 380.7 kB
Release files / spotify_apimatic_sdk-1.0.0.tar.gz
| Download URL | spotify_apimatic_sdk-1.0.0.tar.gz |
|---|---|
| Size | 103.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ce10be9e43aa51d9df45c07c6fc81fa508e10ded8a60621633b07d277a9eefd
|
|
BLAKE2b-256 checksum How to use checksums |
4803208a94e696fb857e9036e45eaeefcbd8aa880ac06b57fa18ad9d59d80cbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / spotify_apimatic_sdk-1.0.0-py3-none-any.whl
| Download URL | spotify_apimatic_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 277.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d65b452839646920cae13713df6f259eed5601763e0784e3c789a8574e8a7cc1
|
|
BLAKE2b-256 checksum How to use checksums |
a901ce6c9191c8284a89fbd67124b0032877cc90826ae44c442e79575a593c8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for spotify-apimatic-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.