Get Catalog Search Suggestions
Fetch the search suggestions for a provided term input.
URL
GET https://api.music.apple.com/v1/catalog/{storefront}/search/suggestionsPath 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 |
|---|---|---|
kinds Required | [string] | The suggestion kinds to include in the results. |
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. |
term Required | string | The text input to use for search suggestions. |
types Optional | [string] | The resource types to include in the |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | SearchSuggestionsResponse | 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 object contains a single terms array. This array contains a list of possible valid search queries determined from the search hint. 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.