App Store app API

Get an app's details from the App Store

curl --request POST \
  --url https://api.stophy.dev/v1/appstore/app \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": "284882215"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({appId: '284882215'})
};

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

import requests

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

payload = { "appId": "284882215" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "appUrl": "<string>",
    "genres": [
      "<string>"
    ],
    "languages": [
      "<string>"
    ],
    "screenshotUrls": [
      "<string>"
    ],
    "ipadScreenshotUrls": [
      "<string>"
    ],
    "appId": "<string>",
    "bundleId": "<string>",
    "name": "<string>",
    "subtitle": "<string>",
    "developerId": "<string>",
    "developerName": "<string>",
    "developerUrl": "<string>",
    "seller": "<string>",
    "website": "<string>",
    "price": 123,
    "priceCurrency": "<string>",
    "priceText": "<string>",
    "hasInAppPurchases": true,
    "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,
    "rating": 123,
    "ratings": 0,
    "ratingsOne": 0,
    "ratingsTwo": 0,
    "ratingsThree": 0,
    "ratingsFour": 0,
    "ratingsFive": 0,
    "chartName": "<string>",
    "chartGenre": "<string>",
    "chartPosition": 0,
    "iconUrl": "<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

app

Get an app's details from the App Store

curl --request POST \
  --url https://api.stophy.dev/v1/appstore/app \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appId": "284882215"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({appId: '284882215'})
};

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

import requests

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

payload = { "appId": "284882215" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "appUrl": "<string>",
    "genres": [
      "<string>"
    ],
    "languages": [
      "<string>"
    ],
    "screenshotUrls": [
      "<string>"
    ],
    "ipadScreenshotUrls": [
      "<string>"
    ],
    "appId": "<string>",
    "bundleId": "<string>",
    "name": "<string>",
    "subtitle": "<string>",
    "developerId": "<string>",
    "developerName": "<string>",
    "developerUrl": "<string>",
    "seller": "<string>",
    "website": "<string>",
    "price": 123,
    "priceCurrency": "<string>",
    "priceText": "<string>",
    "hasInAppPurchases": true,
    "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,
    "rating": 123,
    "ratings": 0,
    "ratingsOne": 0,
    "ratingsTwo": 0,
    "ratingsThree": 0,
    "ratingsFour": 0,
    "ratingsFive": 0,
    "chartName": "<string>",
    "chartGenre": "<string>",
    "chartPosition": 0,
    "iconUrl": "<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"
  }
}

Returns an app’s details from the App Store. The app is identified by its URL or ID.

Request

Exactly one of appUrl or appId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.appstore.app({ appId: "284882215" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.appstore.app(app_id="284882215")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/appstore/app \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"appId":"284882215"}'

stophy appstore app --appId 284882215

Response

If successful, the response body contains the standard envelope. data contains the app’s description, developer, price, ratings, version and screenshots. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "appId": "284882215",
    "appUrl": "https://apps.apple.com/us/app/facebook/id284882215",
    "bundleId": "com.facebook.Facebook",
    "name": "Facebook",
    "subtitle": "Connection starts here",
    "developerId": "284882218",
    "developerName": "Meta Platforms, Inc.",
    "developerUrl": "https://apps.apple.com/us/developer/meta-platforms-inc/id284882218",
    "seller": "Meta Platforms, Inc.",
    "website": "http://www.facebook.com/mobile",
    "price": 0,
    "priceCurrency": "USD",
    "priceText": "Free",
    "hasInAppPurchases": true,
    "genres": ["Social Networking"],
    "primaryGenreId": "6005",
    "primaryGenre": "Social Networking",
    "contentRating": "12+",
    "description": "Where real people propel your curiosity. Whether you’re thrifting gear, showing reels to that group who gets it, or…",
    "releaseNotes": "Our teams have solved many crashes, fixed issues you’ve reported and made the app faster.",
    "version": "581.0.0",
    "releasedAt": "2019-02-05T08:00:00.000Z",
    "updatedAt": "2026-09-30T11:45:51.000Z",
    "minimumOsVersion": "15.1",
    "sizeBytes": 506663936,
    "languages": ["AR"],
    "rating": 4.52602,
    "ratings": 28613672,
    "ratingsOne": 1966781,
    "ratingsTwo": 434356,
    "ratingsThree": 1028701,
    "ratingsFour": 2339531,
    "ratingsFive": 22855070,
    "chartName": "top-free",
    "chartGenre": "Social Networking",
    "chartPosition": 3,
    "iconUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/83/71/5e/83715e23-3e26-c24e-a948-47a168921d0b/Icon-Production-0-0…",
    "screenshotUrls": ["https://is1-ssl.mzstatic.com/image/thumb/PurpleSource221/v4/e2/c0/fa/e2c0faf7-2613-0ead-3c3a-193d992e3930/f254967c-6ef9…"],
    "ipadScreenshotUrls": ["https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/b1/01/cc/b101cce5-ea5d-e1d4-a038-31060001418e/3d69f402-0570-4aa0-…"]
  },
  "creditsUsed": 1,
  "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`.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

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

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

appUrl

string

Link to the App Store app, like https://apps.apple.com/us/app/notes/id1110145109. Send this or appId.

appId

string

App Store app id or bundle id, like 1110145109. Send this or appUrl.

country

string

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

Pattern: ^[A-Za-z]{2}$

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 app 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