Skip to main content
POST
Scrape App Store search results
Scrape App Store search results.

Request

query is required.

Response

If successful, the response body contains the standard envelope. data.results[] contains the matching apps, each with its developer, price and rating. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.

Optional parameters

Billing

A successful request consumes 1 credit per 10 apps, up to 5 credits. Requests that fail, or that return no items, are not billed. Set limit to cap the number of items returned and billed.

Pagination

This method is not paginated. A single request returns the complete result.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
query
string
required
Required string length: 1 - 100
country
string
default:us

ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.

Pattern: ^[A-Za-z]{2}$
device
enum<string>
default:iphone

The device the apps must run on, iphone, ipad or mac. An iPhone app can also run on an iPad or a Mac, so it can show under more than one.

Available options:
iphone,
ipad,
mac
limit
integer

Return at most this many apps. You pay 1 credit per 10 returned.

Required range: 1 <= x <= 50

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required