APapptweak
Keyword Live Search

Keyword Live Search With Ads - Current

Changed on

Returns the app results (including ads) of a live search on the store for a given keyword. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>Credits/request</th></tr></thead> <tbody> <tr><td><b>-</b></td><td>List of app IDs that rank on that keyword. The list starts with the app that ranks first for the keyword (including the ads).</td><td>50</td></tr> </tbody> </table> <Callout icon="🚧" theme="warn"><b>Experiencing a 500 error?</b><p>If you're requesting data for a keyword not currently available in AppTweak's database, you may encounter a timeout resulting in a 500 error. We suggest retrying the request a couple of times. Our team is actively working to optimize this behavior to minimize disruptions.</p></Callout>

get/keywords/search-results/ads/current

Request

  • Base URL
    https://public-api.apptweak.com/api/public/store
  • URL
    https://public-api.apptweak.com/api/public/store/keywords/search-results/ads/current
  • Auth
    API key in header x-apptweak-key

Query parameters

keywordstring required

The keyword to search for. Only one keyword is allowed.

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. Defaults to us.

languagestring

AppTweak language code, not always ISO: US English is us, US Spanish sp. Accepted pairs: <a href="https://developers.apptweak.com/reference/languages-1" target="_blank"><code>GET /api/public/apptweak/languages</code></a> with store=ios or store=android. Defaults to the country's <a href="https://developers.apptweak.com/reference/languages-overview#default-language" target="_blank"><b>default language</b></a>.

device'iphone' | 'ipad' | 'android'

Choose a device from iphone, ipad or android. Defaults to iphone.

Response

Successful response.

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter country, default value was changed from es to us

    • breaking

      for the query request parameter language, default value es was removed

    • breaking

      the response's body type changed from no type to object for status

    • info

      api tag Keyword Live Search added

    • info

      removed subschema #1: iOS subschema #2: Android from the response body oneOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status