| Name | spotify-api-sdk JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | 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. |
| upload_time | 2024-08-23 06:40:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
spotify
apimatic
sdk
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 <a href="https://developer.spotify.com/documentation/general/guides/authorization-guide/">OAuth 2.0</a>.
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</a> 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</a> 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:
```python
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.](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **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. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ['GET', 'PUT']** |
| `authorization_code_auth_credentials` | [`AuthorizationCodeAuthCredentials`](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
The API client can be initialized as follows:
```python
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.
* [`oauth_2_0 (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)
## List of APIs
* [Albums](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/albums.md)
* [Artists](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/artists.md)
* [Audiobooks](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/audiobooks.md)
* [Categories](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/categories.md)
* [Chapters](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/chapters.md)
* [Episodes](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/episodes.md)
* [Genres](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/genres.md)
* [Markets](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/markets.md)
* [Player](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/player.md)
* [Playlists](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/playlists.md)
* [Search](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/search.md)
* [Shows](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/shows.md)
* [Tracks](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/tracks.md)
* [Users](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/users.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "spotify-api-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Spotify, Apimatic, SDK, API",
"author": null,
"author_email": "developer sdksio <developer+sdksio@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/49/63/ec8222da27b8436ac6e5aca28dbfe609c940d8ce19c817641cce2e2bfc4a/spotify_api_sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Spotify Web API\n\n## Introduction\n\nYou 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.\n\nIn 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</a>.\n\nThe base URI for all Web API requests is `https://api.spotify.com/v1`.\n\nNeed help? See our <a href=\"https://developer.spotify.com/documentation/web-api/guides/\">Web API guides</a> 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</a> to ask questions and connect with other developers.\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install spotify-api-sdk==1.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/spotify-api-sdk/1.0.0\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `authorization_code_auth_credentials` | [`AuthorizationCodeAuthCredentials`](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |\n\nThe API client can be initialized as follows:\n\n```python\nclient = SpotifywebapiClient(\n authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(\n o_auth_client_id='OAuthClientId',\n o_auth_client_secret='OAuthClientSecret',\n o_auth_redirect_uri='OAuthRedirectUri',\n o_auth_scopes=[\n OAuthScopeEnum.APP_REMOTE_CONTROL,\n OAuthScopeEnum.PLAYLIST_READ_PRIVATE\n ]\n )\n)\n```\n\nAPI calls return an `ApiResponse` object that includes the following fields:\n\n| Field | Description |\n| --- | --- |\n| `status_code` | Status code of the HTTP response |\n| `reason_phrase` | Reason phrase of the HTTP response |\n| `headers` | Headers of the HTTP response as a dictionary |\n| `text` | The body of the HTTP response as a string |\n| `request` | HTTP request info |\n| `errors` | Errors, if they exist |\n| `body` | The deserialized body of the HTTP response |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`oauth_2_0 (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)\n\n## List of APIs\n\n* [Albums](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/albums.md)\n* [Artists](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/artists.md)\n* [Audiobooks](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/audiobooks.md)\n* [Categories](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/categories.md)\n* [Chapters](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/chapters.md)\n* [Episodes](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/episodes.md)\n* [Genres](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/genres.md)\n* [Markets](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/markets.md)\n* [Player](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/player.md)\n* [Playlists](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/playlists.md)\n* [Search](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/search.md)\n* [Shows](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/shows.md)\n* [Tracks](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/tracks.md)\n* [Users](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/controllers/users.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/spotify-api-python-sdk/tree/1.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "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.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://spotify-poc.pages.dev/"
},
"split_keywords": [
"spotify",
" apimatic",
" sdk",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bf473340babb013f3ab30750caaf13ef570deb326d4540b67951393a2742893",
"md5": "403ecd8ca6f6ccb336790ed1fbbc9a7c",
"sha256": "b915579f31aa661d984d1eb69e8a894713008b62da1afc6274c0ca6f3f74b80c"
},
"downloads": -1,
"filename": "spotify_api_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "403ecd8ca6f6ccb336790ed1fbbc9a7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 231785,
"upload_time": "2024-08-23T06:40:44",
"upload_time_iso_8601": "2024-08-23T06:40:44.327814Z",
"url": "https://files.pythonhosted.org/packages/3b/f4/73340babb013f3ab30750caaf13ef570deb326d4540b67951393a2742893/spotify_api_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4963ec8222da27b8436ac6e5aca28dbfe609c940d8ce19c817641cce2e2bfc4a",
"md5": "8be4645aa0c16ef4c8149df18c8422c6",
"sha256": "af5567738ab9d86571a8ecc23276010bd3867d20731e38fb3a8f29e9fc793337"
},
"downloads": -1,
"filename": "spotify_api_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8be4645aa0c16ef4c8149df18c8422c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 81089,
"upload_time": "2024-08-23T06:40:45",
"upload_time_iso_8601": "2024-08-23T06:40:45.611876Z",
"url": "https://files.pythonhosted.org/packages/49/63/ec8222da27b8436ac6e5aca28dbfe609c940d8ce19c817641cce2e2bfc4a/spotify_api_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 06:40:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "spotify-api-sdk"
}
