> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # App Store app API > Get an app's details from the App Store. Call the App Store app API and get JSON back in one request. 1 credit per call. Failed calls cost nothing. 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`. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} 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); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.appstore.app(app_id="284882215") print(result["data"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/appstore/app \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"appId":"284882215"}' ``` ```bash CLI icon="square-terminal" theme={null} 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. ```json theme={null} { "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. ## Related methods * [App Store reviews](/api-reference/endpoint/appstore-reviews): Accepts `appUrl`. Returns an app's App Store reviews. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/appstore/app openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/appstore/app: post: summary: Get an app's details from the App Store description: Costs 1 credit per call. operationId: appstoreApp requestBody: required: true content: application/json: schema: type: object properties: appUrl: type: string description: >- Link to the App Store app, like https://apps.apple.com/us/app/notes/id1110145109. Send this or appId. appId: type: string description: >- App Store app id or bundle id, like 1110145109. Send this or appUrl. country: type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. sendOne: - appUrl - appId additionalProperties: false example: appId: '284882215' responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: appId: type: string appUrl: type: string format: uri bundleId: type: string name: type: string subtitle: type: string developerId: type: string developerName: type: string developerUrl: type: string format: uri seller: type: string website: type: string format: uri price: type: number priceCurrency: type: string priceText: type: string hasInAppPurchases: type: boolean genres: type: array items: type: string primaryGenreId: type: string primaryGenre: type: string contentRating: type: string description: type: string releaseNotes: type: string version: type: string releasedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ minimumOsVersion: type: string sizeBytes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 languages: type: array items: type: string rating: type: number ratings: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ratingsOne: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ratingsTwo: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ratingsThree: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ratingsFour: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ratingsFive: type: integer minimum: -9007199254740991 maximum: 9007199254740991 chartName: type: string chartGenre: type: string chartPosition: type: integer minimum: -9007199254740991 maximum: 9007199254740991 iconUrl: type: string format: uri screenshotUrls: type: array items: type: string format: uri ipadScreenshotUrls: type: array items: type: string format: uri required: - appUrl - genres - languages - screenshotUrls - ipadScreenshotUrls creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.