Get Catalog Search Results

Fetch metadata for apps and books from the catalog by using a search term.

URL

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

Name	Type	Description
`storefront` Required	string	An iTunes Store territory that you specify with an ISO 3166 alpha-2 country code. The possible values are the `id` attributes of `Storefrontobjects`.

Name	Type	Description
`additionalPlatforms` Optional	[string]	Additional platforms the app supports that you want to get metadata for.
`extend` Optional	[string]	A list of attribute extensions to apply to resources in the response. These attributes are usually more expensive, so only extend them if absolutely necessary. Classifier (optional): A resource type to apply the parameter to, `apps` or `books`.
`filter` Optional	[string]	A filter to apply to the search results. Classifier (required): The filter type, `targetPlatforms` or `genre`. Possible values for `targetPlatforms` are the same as for the `platform` parameter, and the value for `genre` is a genre ID.
`l` Optional	string	The localization to use, which you specify with a language tag. The possible values are in the `supportedLanguageTags` array belonging to the `Storefront` object that `storefront` specifies. Otherwise, the default is `defaultLanguageTag` in `Storefront`.
`platform` Required	string	The platform the user-facing app is running on. You use this to get apps metadata for the specified platform.
`term` Required	string	The text for the search.
`types` Required	[string]	The resource types to include in the search results. Possible values: `apps`, `books`

Status	Reason	Type	Description
200	OK Content-Type: application/json	`ResultsResponse`	The request was successful.
401	Unauthorized Content-Type: application/json	`UnauthorizedResponse`	A response indicating an incorrect `Authorization` header.
500	Internal Server Error Content-Type: application/json	`ErrorsResponse`	A response indicating an error occurred on the server.