// request reference
Apple App Store Search parameters
Send query parameters with GET /api/apple/app-store/search. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
The groups below list every request field, including compatibility restrictions. Read the extended reference for detailed types, defaults, parameter combinations and additional examples.
Request
termRequired search term with 1 to 2,048 UTF-8 bytes of printable text, and at most 4,096 bytes after URL encoding.
Example / input hint: coffee
numMaximum results after filtering, from 1 through 200.
Example / input hint: 10
Filters
disallow_explicitExclude explicit results when true.
Example / input hint: false
truefalsepropertyUse developer to match developer names, ignoring case.
developercategory_idFilter results by a native genre identifier, from 1 through 2,147,483,647.
devicemobile for iPhone apps, tablet for iPad apps, or desktop for Mac apps.
Example / input hint: mobile
mobiletabletdesktopLocalization
countryTwo-letter Apple storefront country. UK is accepted as an alias for GB.
Example / input hint: us
langLanguage-region code, such as en-us or fr-fr.
Example / input hint: en-us
// response
Work with the complete JSON response
Response groups include organic_results, search_information. Groups and fields depend on the upstream result.
The SDK examples use raise_for_error() or raiseForError() so API errors are not mistaken for successful results.