Docs
View as Markdown

apple.app

stable Standard

App Store app details by numeric id (iTunes lookup).

GET /v1/apple/app

What you get#

One Apple record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
idstringyes(required)Numeric Apple idmax 18 chars; must match [0-9]{1,18}; trimmed
countrystringnousTwo-letter storefront country codemax 2 chars; must match [a-z]{2}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/apple/app?id=284882215" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Apple response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "id": "284882215",
      "name": "Facebook",
      "description": "Where real people propel your curiosity. Whether you’re thrifting gear, showing reels to that group who gets it, or sharing laughs over fun images reimagined by AI, Facebook helps you make things happen like no other social network.\n\nExplore and expand your interests: \n* Shop Marketplace for hidden gems and take your hobbies to the next level\n* Personalize your Feed to see more of what you like, less of what you don’t\n* Ask Meta AI for information and get answers instantly\n* Drive into reels that reflect the things you're interested in\n* Search Facebook on any topic and get more interactive results\n\nConnect with people and communities:\n* Join groups to learn tips from real people who’ve been there, done that\n* Get inspired by creators, or catch up with Friends\n* Add new Friends to your world, but also decide how closely to keep up with them\n* Privately message relatable posts that only your BFF will get or that reels trend everyone’s talking about\n\nShare your world:\n* Use generative AI to create custom stickers and images to delight friends\n* Customize your profile to choose how you show up and who sees your posts\n* Effortlessly create reels from trending templates, or showcase your creativity with a full suite of editing tools\n* Capture moments on the fly with stories\n\nSome features may not be available in your country or region. \n\nTerms & Policies: https://www.facebook.com/policies_center\nPrivacy Policy: https://www.facebook.com/privacy\n\nLearn how we're working to help keep our communities safe across Meta technologies at the Meta Safety Center: https://about.meta.com/actions/safety",
      "url": "https://apps.apple.com/us/app/facebook/id284882215?uo=4",
      "category": "Social Networking",
      "stats": {
        "rating": 4.5259,
        "ratingCount": 28524686
      }
    },
    "ext": {
      "bundleId": "com.facebook.Facebook",
      "developer": "Meta Platforms, Inc.",
      "contentRating": "12+",
      "sizeBytes": 507062272,
      "minimumOs": "15.1"
    },
    "package": {
      "version": "580.0.0"
    },
    "listing": {
      "price": 0,
      "currency": "USD"
    },
    "content": {
      "createdAt": "2019-02-05T08:00:00Z",
      "updatedAt": "2026-09-23T07:37:44Z"
    },
    "media": {
      "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/4a/d2/9f/4ad29fa6-ac86-66b9-3c9e-2c9950173431/Icon-Production-0-0-1x_U007epad-0-1-0-sRGB-85-220.png/512x512bb.jpg"
    }
  },
  "metadata": {
    "platform": "apple",
    "endpoint": "app",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
trackIdentity.idtoString
trackNameentity.name-
bundleIdext.bundleId-
descriptionentity.description-
versionpackage.version-
artistNameext.developer-
trackViewUrlentity.urlsafeUrl
pricelisting.pricetoNumber
currencylisting.currency-
primaryGenreNameentity.category-
contentAdvisoryRatingext.contentRating-
averageUserRatingentity.stats.ratingtoNumber
userRatingCountentity.stats.ratingCounttoNumber
fileSizeBytesext.sizeBytestoNumber
releaseDatecontent.createdAttoIsoDate
currentVersionReleaseDatecontent.updatedAttoIsoDate
minimumOsVersionext.minimumOs-
artworkUrl512media.thumbnailUrlsafeUrl

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).