Docs
View as Markdown

googleplay.app

stable Advanced

Google Play app page metadata (title, description, image).

GET /v1/googleplay/app

What you get#

One Googleplay 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: /google_play/app-info on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

  • Advanced · 5 credits 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
packagestringyes(required)Android application idmax 150 chars; must match [A-Za-z][A-Za-z0-9_]*(?:\.[A-Za-z0-9_]+)+; trimmed
langstringnoenLanguage codemax 2 chars; must match [a-z]{2}; trimmed, lowercased
countrystringnousCountry codemax 2 chars; must match [a-z]{2}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/googleplay/app?package=com.spotify.music" \
  -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 Googleplay response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "url": "https://play.google.com/store/apps/details?id=com.spotify.music&hl=en&gl=us",
      "name": "Spotify: Music and Podcasts - Apps on Google Play",
      "description": "Listen to songs, play podcasts, create playlists and discover music you'll love"
    },
    "media": {
      "thumbnailUrl": "https://play-lh.googleusercontent.com/IzQgYCcnCFCD08GR-3bdtcT8xzOvrNkC84avGT5CwTX2VIqmTmKKJcP_Cd4JoBOdmCMlTndlOzV6hrthg2fOWA=s0-br30"
    },
    "ext": {
      "canonicalUrl": "https://play.google.com/store/apps/details?id=com.spotify.music&hl=en"
    },
    "content": {
      "language": "en"
    }
  },
  "metadata": {
    "platform": "googleplay",
    "endpoint": "app",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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
finalUrlentity.urlsafeUrl
openGraph.titleentity.name-
descriptionentity.description-
imageUrlmedia.thumbnailUrlsafeUrl
canonicalUrlext.canonicalUrlsafeUrl
languagecontent.language-

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 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).