App Store search API

Search App Store apps

curl --request POST \
  --url https://api.stophy.dev/v1/appstore/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "notes",
  "country": "gb",
  "device": "ipad"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'notes', country: 'gb', device: 'ipad'})
};

fetch('https://api.stophy.dev/v1/appstore/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/appstore/search"

payload = {
    "query": "notes",
    "country": "gb",
    "device": "ipad"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "appUrl": "<string>",
        "appId": "<string>",
        "bundleId": "<string>",
        "name": "<string>",
        "developerId": "<string>",
        "developerName": "<string>",
        "developerUrl": "<string>",
        "seller": "<string>",
        "website": "<string>",
        "price": 123,
        "priceCurrency": "<string>",
        "priceText": "<string>",
        "genres": [
          "<string>"
        ],
        "primaryGenreId": "<string>",
        "primaryGenre": "<string>",
        "contentRating": "<string>",
        "description": "<string>",
        "releaseNotes": "<string>",
        "version": "<string>",
        "releasedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "minimumOsVersion": "<string>",
        "sizeBytes": 0,
        "languages": [
          "<string>"
        ],
        "rating": 123,
        "ratings": 0,
        "iconUrl": "<string>",
        "screenshotUrls": [
          "<string>"
        ],
        "ipadScreenshotUrls": [
          "<string>"
        ]
      }
    ]
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

appstore

Search App Store apps

curl --request POST \
  --url https://api.stophy.dev/v1/appstore/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "notes",
  "country": "gb",
  "device": "ipad"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'notes', country: 'gb', device: 'ipad'})
};

fetch('https://api.stophy.dev/v1/appstore/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/appstore/search"

payload = {
    "query": "notes",
    "country": "gb",
    "device": "ipad"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "appUrl": "<string>",
        "appId": "<string>",
        "bundleId": "<string>",
        "name": "<string>",
        "developerId": "<string>",
        "developerName": "<string>",
        "developerUrl": "<string>",
        "seller": "<string>",
        "website": "<string>",
        "price": 123,
        "priceCurrency": "<string>",
        "priceText": "<string>",
        "genres": [
          "<string>"
        ],
        "primaryGenreId": "<string>",
        "primaryGenre": "<string>",
        "contentRating": "<string>",
        "description": "<string>",
        "releaseNotes": "<string>",
        "version": "<string>",
        "releasedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "minimumOsVersion": "<string>",
        "sizeBytes": 0,
        "languages": [
          "<string>"
        ],
        "rating": 123,
        "ratings": 0,
        "iconUrl": "<string>",
        "screenshotUrls": [
          "<string>"
        ],
        "ipadScreenshotUrls": [
          "<string>"
        ]
      }
    ]
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Searches App Store apps.

Request

query is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.appstore.search({ query: "notes", country: "gb", device: "ipad" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.appstore.search(query="notes", country="gb", device="ipad")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/appstore/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"notes","country":"gb","device":"ipad"}'

stophy appstore search notes --country gb --device ipad

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.

{
  "success": true,
  "data": {
    "results": [
      {
        "appId": "1110145109",
        "appUrl": "https://apps.apple.com/gb/app/notes/id1110145109",
        "bundleId": "com.apple.mobilenotes",
        "name": "Notes",
        "developerId": "284417353",
        "developerName": "Apple",
        "developerUrl": "https://apps.apple.com/gb/developer/apple/id284417353",
        "seller": "Apple Distribution International",
        "price": 0,
        "priceCurrency": "GBP",
        "priceText": "Free",
        "genres": ["Productivity"],
        "primaryGenreId": "6007",
        "primaryGenre": "Productivity",
        "contentRating": "4+",
        "description": "Notes is the best place to jot down quick thoughts or to save longer notes filled with checklists, images, web links,…",
        "releaseNotes": "Bug Fixes and Feature Enhancements",
        "version": "2.6",
        "releasedAt": "2016-05-23T21:11:44.000Z",
        "updatedAt": "2026-09-14T20:09:43.000Z",
        "minimumOsVersion": "15.0",
        "sizeBytes": 6054912,
        "languages": ["AR", "CA"],
        "rating": 4.78604,
        "ratings": 68400,
        "iconUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/bc/b1/1c/bcb11c9d-ea61-089f-3b84-0f8911dd175d/notesCalistoga-0-0-…",
        "screenshotUrls": ["https://is1-ssl.mzstatic.com/image/thumb/PurpleSource221/v4/04/16/68/041668d9-0672-cb3c-2e98-a9bf013e5594/1_Notes_scree…", "https://is1-ssl.mzstatic.com/image/thumb/PurpleSource211/v4/6e/6f/21/6e6f2140-71b0-4545-6ad6-0e87b1401418/2_Notes_PDF_S…"],
        "ipadScreenshotUrls": ["https://is1-ssl.mzstatic.com/image/thumb/PurpleSource221/v4/02/f6/94/02f69477-9ea2-56ee-4fb5-53aea34b17f5/1_Notes_iPad_…", "https://is1-ssl.mzstatic.com/image/thumb/PurpleSource211/v4/1f/ba/f4/1fbaf44d-ab61-8bdf-647e-999381c5bf74/2_Notes_iPad_…"]
      }
    ]
  },
  "creditsUsed": 5,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`rating`	number	The average star rating, on a scale of 1 to 5.
`ratings`	integer	The number of ratings the app has received.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`country`	string	The country to query, as a two-letter ISO 3166-1 code such as `us`. If unset, defaults to `us`.
`device`	string	The Apple device store to read. Acceptable values are `iphone`, `ipad` and `mac`. If unset, defaults to `iphone`.
`limit`	integer	The maximum number of apps to return. Billed at 1 credit per 10 returned. Must be between 1 and 50.

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.

App Store app: Accepts appUrl. Returns an app’s details from the App Store.
App Store reviews: Accepts appUrl. Returns an app’s App Store reviews.

Authorizations

Authorization

string

header

required

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

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

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

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

App Store search API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods