Contents

Search for Apps

Search the App Store for apps matching the supplied criteria and return app details.

URL

GET https://api.ads.apple.com/v1/search/apps

Query Parameters

NameTypeDescription
query Optionalstring

Free-text search matched against app name and developer name. Must contain at least one alphanumeric character and a minimum of 3 characters (2 for CJK languages).

returnOwnedApps Optionalboolean

Flag that returns apps owned by the caller’s organization when set to true. Can be combined with query and cpids, or used on its own. Defaults to false.

cpids Optionalstring

Comma-separated list of iTunes content provider identifiers. Scopes the search to apps owned by those providers.

storeFronts Optional[string]

One or more App Store country or region codes (ISO 3166-1 alpha-2). Repeat the parameter for multiple values. All values must be enabled App Store countries or regions, or the call returns INVALID_COUNTRY_CODE.

offset Optionalint32

Pagination offset for results. Defaults to 0.

limit Optionalint32

Maximum number of results to return. Defaults to 20, capped at the service-side maximum (MAXLIMIT).

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppsSearchResponse
400Bad Request
Content-Type: application/json
Error
401Unauthorized
Content-Type: application/json
Error
403Forbidden
Content-Type: application/json
Error
404Not Found
Content-Type: application/json
Error
429Too Many Requests
Content-Type: application/json
Error
500Internal Server Error
Content-Type: application/json
Error

Query Parameters

Discussion

This endpoint searches the App Store for apps by name, content provider, or returns apps owned by the caller’s organization. It’s useful for discovering apps to target or advertise before building campaigns.

You must supply at least one of query, cpids, or returnOwnedApps=true. The API rejects calls that supply none of these with INVALID_INPUT.

The returned adamId is the primary identifier used in campaign promotedObject and creative destination fields.

Payload Examples

See Also