Get Equivalent Catalog Songs by ID
Fetch the equivalent, available content in the storefront for the provided songs’ identifiers.
URL
GET https://api.music.apple.com/v1/catalog/{storefront}/songsPath Parameters
| Name | Type | Description |
|---|---|---|
storefront Required | string | An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the |
Query Parameters
| Name | Type | Description |
|---|---|---|
filter[equivalents] Required | [string] | A filter to apply to the request. The maximum fetch limit is 300. |
include Optional | [string] | Additional relationships to include in the fetch. |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
restrict Optional | [string] | A set of restrictions (for example, to restrict explicit content). |
extend Optional | [string] | A list of attribute extensions to apply to resources in the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SongsResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 500 | Internal Server Error Content-Type: application/json | ErrorsResponse | A response indicating an error occurred on the server. |
Discussion
If successful, the HTTP status code is 200 (OK) and the data array contains the requested resource object. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. For more information, see Handling Requests and Responses.