Docs
View as Markdown

amo.top_themes

stable Advanced

Most-used Firefox themes (AMO).

GET /v1/amo/top_themes

What you get#

A list of Amo results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

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#

This endpoint takes no parameters.

Request#

curl "https://api.onekey.dev/v1/amo/top_themes" \
  -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 Amo response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "2785297",
        "name": {
          "en-US": "Activist – Balanced"
        },
        "slug": "activist-balanced_",
        "description": {
          "en-US": "You leave the world a better place than you found it and lead others to believe."
        },
        "url": "https://addons.mozilla.org/en-US/firefox/addon/activist-balanced_/",
        "type": "statictheme",
        "stats": {
          "rating": 4.6346,
          "ratingCount": 156
        },
        "tags": [
          "firefox"
        ]
      },
      "package": {
        "version": "2.1"
      },
      "ext": {
        "developer": "Firefox",
        "users": 307914,
        "weeklyDownloads": 641
      },
      "content": {
        "createdAt": "2023-02-03T15:37:48Z",
        "updatedAt": "2023-02-03T15:46:41Z"
      },
      "media": {
        "thumbnailUrl": "https://addons.mozilla.org/static-server/img/addon-icons/default-64.png"
      }
    },
    {
      "entity": {
        "id": "2785324",
        "name": {
          "en-US": "Visionary – Balanced"
        },
        "slug": "visionary-balanced",
        "description": {
          "en-US": "You question the status quo and move others to imagine a better future."
        },
        "url": "https://addons.mozilla.org/en-US/firefox/addon/visionary-balanced/",
        "type": "statictheme",
        "stats": {
          "rating": 4.4559,
          "ratingCount": 68
        },
        "tags": [
          "firefox"
        ]
      },
      "package": {
        "version": "2.1"
      },
      "ext": {
        "developer": "Firefox",
        "users": 190602,
        "weeklyDownloads": 198
      },
      "content": {
        "createdAt": "2023-02-03T17:30:34Z",
        "updatedAt": "2023-02-03T18:28:58Z"
      },
      "media": {
        "thumbnailUrl": "https://addons.mozilla.org/static-server/img/addon-icons/default-64.png"
      }
    }
  ],
  "metadata": {
    "platform": "amo",
    "endpoint": "top_themes",
    "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
identity.idtoString
nameentity.name-
slugentity.slug-
summaryentity.descriptionstripHtml
urlentity.urlsafeUrl
typeentity.type-
current_version.versionpackage.version-
authors.0.nameext.developer-
average_daily_usersext.userstoNumber
weekly_downloadsext.weeklyDownloadstoNumber
ratings.averageentity.stats.ratingtoNumber
ratings.countentity.stats.ratingCounttoNumber
createdcontent.createdAttoIsoDate
last_updatedcontent.updatedAttoIsoDate
categoriesentity.tags-
icon_urlmedia.thumbnailUrlsafeUrl

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 1 minute 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_foundUnknown endpoint path.
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).