The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Net::Async::Spotify::API::Generated::Artists at lib/Net/Async/Spotify/API/Generated/Artists.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line.
NAME
Net::Async::Spotify::API::Generated::Artists - Package representing Spotify Artists API
DESCRIPTION
Autogenerated module. Based on https://developer.spotify.com/documentation/web-api/reference/#reference-index Check crawl-api-doc.pl for more information.
METHODS
get_an_artist
get_an_artist - Get an Artist
Get Spotify catalog information for a single artist identified by their unique Spotify ID.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID of the artist.
and Response Objects being:
- artist object
On success, the HTTP status code in the response header is 200 OK and the response body contains an artist object in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_an_artists_albums
get_an_artists_albums - Get an Artist's Albums
Get Spotify catalog information about an artist’s albums.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID for the artist.
query_parameter
- include_groups
-
Type: string | Required: optional A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are:- album- single- appears_on- compilationFor example: include_groups=album,single.
- limit
-
Type: integer | Required: optional The number of album objects to return. Default: 20. Minimum: 1. Maximum: 50. For example: limit=2
- market
-
Type: string | Required: optional Synonym for country. An ISO 3166-1 alpha-2 country code or the string from_token.Supply this parameter to limit the response to one particular geographical market. For example, for albums available in Sweden: market=SE.If not given, results will be returned for all markets and you are likely to get duplicate results per album, one for each market in which the album is available!
- offset
-
Type: integer | Required: optional The index of the first album to return. Default: 0 (i.e., the first album). Use with limit to get the next set of albums.
and Response Objects being:
- album object
On success, the HTTP status code in the response header is 200 OK and the response body contains an array of simplified album objects (wrapped in a paging object) in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_an_artists_related_artists
get_an_artists_related_artists - Get an Artist's Related Artists
Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the Spotify community’s listening history.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID for the artist
and Response Objects being:
- an object
On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is "artists" and whose value is an array of up to 20 artist objects in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_an_artists_top_tracks
get_an_artists_top_tracks - Get an Artist's Top Tracks
Get Spotify catalog information about an artist’s top tracks by country.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
path_parameter
- id
-
Type: string | Required: required The Spotify ID for the artist
query_parameter
- market
-
Type: string | Required: required An ISO 3166-1 alpha-2 country code or the string from_token. Synonym for country.
and Response Objects being:
- an object
On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is "tracks" and whose value is an array of up to 10 track objects in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
get_multiple_artists
get_multiple_artists - Get Multiple Artists
Get Spotify catalog information for several artists based on their Spotify IDs.
with Request details being:
header
- Authorization
-
Type: string | Required: required A valid user access token or your client credentials.
query_parameter
- ids
-
Type: string | Required: required A comma-separated list of the Spotify IDs for the artists. Maximum: 50 IDs.
and Response Objects being:
- an object - an object
On success, the HTTP status code in the response header is 200 OK and the response body contains an object whose key is "artists" and whose value is an array of artist objects in JSON format.Objects are returned in the order requested. If an object is not found, a null value is returned in the appropriate position. Duplicate ids in the query will result in duplicate objects in the response. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console