Contents

Get Equivalent Catalog Music Videos by ID

Fetch the equivalent, available content in the storefront for the provided music videos’ identifiers.

URL

GET https://api.music.apple.com/v1/catalog/{storefront}/music-videos

Path Parameters

NameTypeDescription
storefront Requiredstring

An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the id attributes of Storefront objects.

Query Parameters

NameTypeDescription
filter[equivalents] Required[string]

A filter to apply to the request. The maximum fetch limit is 25.

include Optional[string]

Additional relationships to include in the fetch.

l Optionalstring

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the default is defaultLanguageTag in Storefront.

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

StatusReasonTypeDescription
200OK
Content-Type: application/json
MusicVideosResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

500Internal 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.

Example

See Also

Related Documentation

Requesting a Catalog Music Video