itunes.lookup_app

stable Standard

App Store app by id.

GET /v1/itunes/lookup_app

What you get#

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

Also known as: /app_store/app-info on APIs that nest their paths. See Alternatives and equivalents.

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#

Name	Type	Required	Default	What it is	Constraints
`id`	string	yes	(required)	iTunes/Apple id	max 12 chars; must match `[0-9]{1,12}`; trimmed
`country`	string	no	`us`	2-letter store country, e.g. us	max 2 chars; must match `[a-z]{2}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/itunes/lookup_app?id=310633997" \
  -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 Itunes response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "310633997",
      "name": "WhatsApp Messenger",
      "description": null,
      "url": null,
      "category": "Social Networking",
      "stats": {
        "rating": null,
        "ratingCount": null
      }
    },
    "author": {
      "displayName": "WhatsApp Inc."
    },
    "package": {
      "version": "26.37.76"
    },
    "media": {
      "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/48/fb/85/48fb85ea-89b9-b577-aa96-d4e3abef3486/AppIcon-0-0-1x_U007epad-0-0-0-1-0-0-sRGB-0-85-220.png/100x100bb.jpg"
    },
    "listing": {
      "price": 0
    }
  },
  "metadata": {
    "platform": "itunes",
    "endpoint": "lookup_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 path	Onekey field	Transform
`trackId`	`entity.id`	`toString`
`trackName`	`entity.name`	-
`artistName`	`author.displayName`	-
`description`	`entity.description`	-
`version`	`package.version`	-
`trackViewUrl`	`entity.url`	`safeUrl`
`artworkUrl100`	`media.thumbnailUrl`	`safeUrl`
`primaryGenreName`	`entity.category`	-
`price`	`listing.price`	`toNumber`
`averageUserRating`	`entity.stats.rating`	`toNumber`
`userRatingCount`	`entity.stats.ratingCount`	`toNumber`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day 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 3 days 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#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).