HAQM Music Web API

Web API Artists V1.0

Important: These HAQM Music APIs are currently in a closed Beta. Please check back soon for updates.

Important: These HAQM Music documents are in preview status. Be aware that content may change. Please use the developer forum for any questions or comments.

Artists

Retrieve artist and related meta-data from the HAQM Music catalog.

Get Artist
Get Multiple Artists
Get Artist Albums
Get Artist Tracks
Get Related Artists
Get Artist Followers
Get Current User's Followed Artists

Get Artist

GET

/artists/{id}

Authorization Scope: [music::catalog]

Get the HAQM Music catalog meta-data for a single artist by artist ID. The meta-data includes the name of the artist, associated images, and more.

Path Parameters

Name	Data Type	Required	Description
id	string	No	The ID of the artist to be retrieved.

Example

curl --request GET <base url>/v1/artists/B01EJ9KLA6
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Response

HAQM Music response object containing information about the artist.

Name	Data Type	Required	Description
Artist	Artist	No	Data about the HAQM Music artist

Example

{
  "data": {
    "artist": {
            "id": "B01EJ9KLA6",
            "globalAsin": "B01EJ9KLA6",
            "images": [
                {
                    "height": 1920,
                    "width": 2560,
                    "url": "http://m.media-haqm.com/images/I/71EUeu1uvbL.jpg",
                    "imageType": "BACKGROUND"
                },
                {
                    "height": 500,
                    "width": 500,
                    "url": "http://m.media-haqm.com/images/I/714AGFYsl8L.jpg",
                    "imageType": "PROFILE"
                }
            ],
            "name": "Tash Sultana",
            "url": "http://music.haqm.com/artists/B01EJ9KLA6"
        }
  }
}

Get Multiple Artists

GET

/artists

Authorization Scope: [music::catalog]

Get the HAQM Music catalog meta-data for multiple artists identified by comma-separated catalog IDs. This meta-data includes the name of the artist, associated images, and more.

Query Parameters

Name	Data Type	Required	Description
ids	string	No	A comma-separated list of the IDs of the artists to be retrieved. There is a maximum limit of 100 IDs.

Example

curl --request GET <base url>/v1/artists/?ids=B0012CBBDU,B000YPUBKK
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing an array of artists.

Name	Data Type	Required	Description
Artist	artist[]	No	Data about the HAQM Music artist

Example

{
  "data": {
    "artists": [
            {
                "id": "B0012CBBDU",
                "globalAsin": "B0012CBBDU",
                "images": [
                    {
                        "height": 1920,
                        "width": 2560,
                        "url": "http://m.media-haqm.com/images/I/71rO4bJicLL.jpg",
                        "imageType": "BACKGROUND"
                    },
                    {
                        "height": 500,
                        "width": 500,
                        "url": "http://m.media-haqm.com/images/I/71HgLmWpxrL.jpg",
                        "imageType": "PROFILE"
                    }
                ],
                "name": "Stick Figure",
                "url": "http://music.haqm.com/artists/B0012CBBDU"
            },
            {
                "id": "B000YPUBKK",
                "globalAsin": "B000YPUBKK",
                "images": [
                    {
                        "height": 375,
                        "width": 500,
                        "url": "http://m.media-haqm.com/images/I/514rM8hJn4L.jpg",
                        "imageType": "BACKGROUND"
                    }
                ],
                "name": "Rebelution",
                "url": "http://music.haqm.com/artists/B000YPUBKK"
            }
        ]
  }
}

Get Artist Albums

GET

/artists/{id}/albums

Authorization Scope: [music::catalog]

Get HAQM Music catalog meta-data about the albums of a specified artist. Optional parameters can be used to limit the number of albums returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The HAQM Music catalog ID of the artist.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of albums to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/artists/B077DT8KHW/albums?limit=2'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing a response collection of albums related to the artist:

Name	Data Type	Required	Description
artist	Response Collection	No	Collection of albums related to this artist

Example

{
  "data": {
        "artist": {
            "id": "B077DT8KHW",
            "name": "Måneskin",
            "albums": {
                "pageInfo": {
                    "hasNextPage": true,
                    "token": "tcs-V2_SgvDeNVpl=="
                },
                "edgeCount": 2,
                "edges": [
                    {
                        "node": {
                            "id": "B077XF8X4W",
                            "title": "Chosen [Explicit]",
                            "url": "http://music.haqm.com/albums/B077XF8X4W"
                        }
                    },
                    {
                        "node": {
                            "id": "B09YZ163QX",
                            "title": "SUPERMODEL",
                            "url": "http://music.haqm.com/albums/B09YZ163QX"
                        }
                    }
                ]
            }
        }
    }
}

Get Artist Tracks

GET

/artists/{id}/tracks

Authorization Scope: [music::catalog]

Get the HAQM Music catalog meta-data for an artist’s top tracks. Optional parameters can be used to limit the number of tracks returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	No	The ID of the artist whose tracks are to be retrieved.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of tracks to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET <base url>/v1/artists/B000QJRL7A/tracks?limit=2
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing a response collection of tracks related to the artist:

Name	Data Type	Required	Description
artist	Response Collection	No	Collection of tracks related to this artist

Example

{
  "data": {
    "artist": {
            "id": "B000QJRL7A",
            "name": "SOJA",
            "tracks": {
                "pageInfo": {
                    "hasNextPage": true,
                    "token": "tcs-V2_SgvgeSW"
                },
                "edgeCount": 2,
                "edges": [
                    {
                        "node": {
                            "id": "B097S185X9",
                            "title": "Something To Believe In",
                            "isrc": "USATO2100125",
                            "url": "http://music.haqm.com/albums/B097S29G3W/?trackAsin=B097S185X9"
                        }
                    },
                    {
                        "node": {
                            "id": "B07KNNSBQX",
                            "title": "Everything Changes [Explicit]",
                            "isrc": "USATO1100243",
                            "url": "http://music.haqm.com/albums/B07KNMLJJX/?trackAsin=B07KNNSBQX"
                        }
                    }
                ]
            }
        }
  }
}

GET

/artists/{id}/related

Authorization Scope: [music::catalog]

Get HAQM Music catalog information about artists similar to a specified artist. Similarity is based on analysis of the current user’s listening history. Optional parameters can be used to limit the number of artists returned.

Learn more about pagination.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The catalog ID of the artist.

Query Parameters

Name	Data Type	Required	Description
limit	number	No	The maximum number of similar artists to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1//artists/B000S9ULT8/related?limit=2'
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing a response collection of artists related to the artist:

Name	Data Type	Required	Description
artist	Response Collection	No	Collection of artists related to this artist

Example

{
  "data": {
    "artist": {
      "id": "B000S9ULT8",
      "name": "Daft Punk",
      "related": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "8d71515c-e8b8-4b0b-a33c-6210a7dc89e1.2"
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "B000QKE8H0",
              "name": "Modjo",
              "url": "http://music.haqm.com/artists/B000QKE8H0"
            }
          },
          {
            "node": {
              "id": "B000QJPQTA",
              "name": "Pharrell Williams",
              "url": "http://music.haqm.com/artists/B000QJPQTA"
            }
          }
        ]
      }
    }
  }
}

Get Artist Followers

GET

/artists/{id}/followers

Authorization Scope: [music::catalog]

Get follower information for a specified artist based on their HAQM Music ID.

Path Parameters

Name	Data Type	Required	Description
id	string	Yes	The HAQM Music ID of the artist.

Example

curl --request GET '<base url>/v1/artists/B000S9ULT8/followers' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
artist	Artist	No	Data about the specified artist

Example

{
  "data": {
    "artist": {
      "id": "B000S9ULT8",
      "name": "Daft Punk",
      "followerCount": 203164,
      "url": "http://music.haqm.com/artists/B000S9ULT8"
    }
  }
}

Get Current User's Followed Artists

GET

/me/followed/artists

Authorization Scope: [music::favorites:read]

Get the current HAQM Music user’s list of followed artists. Optional parameters can be used to limit the number of artists returned.

Learn more about pagination.

Query Parameters

Name	Data Type	Required	Description
artistIds	string	No	Artist IDs to limit the results to.
limit	number	No	The maximum number of artists to return (default: 100). Minimum of 1, maximum of 100.
cursor	string	No	The cursor/token for the page to continue pagination results from.

Example

curl --request GET '<base url>/v1/me/followed/artists' \
--header 'x-api-key: <your security profile ID>' \
--header 'Authorization: Bearer <your auth token>'

Responses

HAQM Music response object containing:

Name	Data Type	Required	Description
user	User	No	Data about the current HAQM Music user, including followed artists

Example

{
  "data": {
    "user": {
      "id": "zqll6htnhyb2welrqsrtrhdvaa",
      "name": "Tony Starked",
      "url": "http://music.haqm.com/profiles/zqll6htnhyb2welrqsrtrhdvaa",
      "followedArtists": {
        "pageInfo": {
          "hasNextPage": true,
          "token": "rO0ABXNyADhjb20uYW1hem9uLm11c2ljLnJlbGF0aW9uc2hpcC5ncmFwaC5wYWdpbmF0aW9uLlBhZ2VUb2tlbjR9daSapeQtAgADSQAFaW5kZXhJAAhwYWdlU2l6ZUwACXRpbWVzdGFtcHQAE0xqYXZhL3RpbWUvSW5zdGFudDt4cAAAAAIAAAACc3IADWphdmEudGltZS5TZXKVXYS6GyJIsgwAAHhwdw0CAAAAAGD55C0ZRboAeA=="
        },
        "edgeCount": 2,
        "edges": [
          {
            "node": {
              "id": "B000QKGN8W",
              "name": "Coldplay",
              "url": "http://music.haqm.com/artists/B000QKGN8W"
            }
          },
          {
            "node": {
              "id": "B000S2A8NE",
              "name": "XYZ",
              "url": "http://music.haqm.com/artists/B000S2A8NE"
            }
          }
        ]
      }
    }
  }
}

HAQM Music Web API

Web API Artists V1.0

Artists

Get Artist

Path Parameters

Example

Response

Example

Get Multiple Artists

Query Parameters

Example

Responses

Example

Get Artist Albums

Path Parameters

Query Parameters

Example

Responses

Example

Get Artist Tracks

Path Parameters

Query Parameters

Example

Responses

Example

Get Related Artists

Path Parameters

Query Parameters

Example

Responses

Example

Get Artist Followers

Path Parameters

Example

Responses

Example

Get Current User's Followed Artists

Query Parameters

Example

Responses

Example