Search for Catalog Resources
Search the catalog by using a query.
URL
GET https://api.music.apple.com/v1/catalog/{storefront}/searchPath 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 |
|---|---|---|
term Required | string | The entered text for the search with ‘ |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
limit Optional | integer | The number of objects or number of objects in the specified relationship returned. |
offset Optional | string | The next page or group of objects to fetch. |
types Required | [string] | The list of the types of resources to include in the results. |
with Optional | [string] | A list of modifications to apply to the request. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SearchResponse | 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 results contains a map of search results. 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.