Contents

Get Catalog Search Hints

Fetch the search term results for a hint.

URL

GET https://api.music.apple.com/v1/catalog/{storefront}/search/hints

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
term Requiredstring

The entered text for the search with ‘+’ characters between each word, to replace spaces (for example term=james+br).

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.

limit Optionalinteger

The number of objects or number of objects in the specified relationship returned.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SearchHintsResponse

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

These results are autocompletion options for the hint and are potential search terms. For more information, see Search for Catalog Resources.

Example

See Also

Related Documentation

Searching for Catalog Resources