App search

Search apps by name

Get the application ids matching an app name, or part of one, on the App Store and on Google Play in a single call, ranked by store relevance. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>Credits/request</th></tr></thead> <tbody> <tr><td><b>candidate object</b></td><td>Hash containing the application id, the title and the icon of each candidate, for both stores.</td><td>11</td></tr> </tbody> </table> <br/><br/> The price does not change with limit. A rejected parameter costs 1 credit. A request that reaches neither store costs nothing. <br/><br/> Every endpoint of the AppTweak API takes an application id: a numeric id on the App Store, a package name on Google Play. This endpoint is the way in when all you have is a name: it searches both stores in one call and returns the candidates side by side, so you can pick the right app before spending credits on data endpoints. The response will be a JSON which contains one array of candidates per store, ranked by store relevance, without pagination. <br/><br/> <b>Good to know</b> <br/><br/> • This is a store search and not an exact lookup: candidates come back ranked by store relevance, and the first one is not necessarily the app you meant. Check title before using an id.<br/>• If one store is unavailable the request still succeeds, with that store's array empty, and still costs 11 credits.<br/>• Each store applies its own default language for the requested country, and the two are not always the same: for in, the App Store is searched in en and Google Play in in.

get/user/resolve_app_id_by_app_name

Request

  • Base URL
    https://public-api.apptweak.com/api/public/apptweak
  • URL
    https://public-api.apptweak.com/api/public/apptweak/user/resolve_app_id_by_app_name
  • Auth
    API key in header x-apptweak-key

Query parameters

querystring required

The app name, or part of it, to search for. Surrounding whitespace is stripped and an empty value returns a 422. <br/><b>Example:</b> strava

limitinteger

The number of candidates you want to fetch per store, from 1 to 10. It does not change the price. <br/><b>Default:</b> 5

countrystring

Two-letter country code (us, gb, fr). Accepted values: <a href="https://developers.apptweak.com/reference/countries-1" target="_blank"><code>GET /api/public/apptweak/countries</code></a> with store=ios or store=android. It selects the storefront to search. The search language is not a parameter: each store applies its own default language for that country. <br/><b>Default:</b> us

Response

Candidates per store. A store that could not be reached comes back as an empty array.

Changes

No recorded changes to this operation across all 1 revision of this API.