amo.search

stable Advanced

Search Firefox add-ons (AMO).

GET /v1/amo/search

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#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/amo/search?q=dark" \
  -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": "2653216",
        "name": {
          "en-US": "Dark Mode"
        },
        "slug": "dark-mode-by-albert-inc",
        "description": {
          "en-US": "Dark theme and night shift mode for every website. Care your eyes, use Dark Mode for night and daily web browsing."
        },
        "url": "https://addons.mozilla.org/en-US/firefox/addon/dark-mode-by-albert-inc/",
        "type": "extension",
        "stats": {
          "rating": 3.1667,
          "ratingCount": 222
        },
        "tags": [
          "appearance"
        ]
      },
      "package": {
        "version": "2.3.0"
      },
      "ext": {
        "developer": "Dark Mode",
        "users": 50512,
        "weeklyDownloads": 2331
      },
      "content": {
        "createdAt": "2020-07-17T16:36:39Z",
        "updatedAt": "2020-07-17T18:15:11Z"
      },
      "media": {
        "thumbnailUrl": "https://addons.mozilla.org/user-media/addon_icons/2653/2653216-64.png?modified=3253ba76"
      }
    },
    {
      "entity": {
        "id": "2749095",
        "name": {
          "en-CA": "Dark",
          "en-US": null,
          "_default": "en-CA"
        },
        "slug": "autumn-twining",
        "description": {
          "en-CA": "Beautiful dark theme for your beloved browser.",
          "en-US": null,
          "_default": "en-CA"
        },
        "url": "https://addons.mozilla.org/en-US/firefox/addon/autumn-twining/",
        "type": "statictheme",
        "stats": {
          "rating": 4.8846,
          "ratingCount": 26
        },
        "tags": [
          "seasonal"
        ]
      },
      "package": {
        "version": "1.0"
      },
      "ext": {
        "developer": "if_tea",
        "users": 3276,
        "weeklyDownloads": 159
      },
      "content": {
        "createdAt": "2022-04-22T17:10:53Z",
        "updatedAt": "2022-04-22T17:12:53Z"
      },
      "media": {
        "thumbnailUrl": "https://addons.mozilla.org/static-server/img/addon-icons/default-64.png"
      }
    }
  ],
  "metadata": {
    "platform": "amo",
    "endpoint": "search",
    "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 path	Onekey field	Transform
`id`	`entity.id`	`toString`
`name`	`entity.name`	-
`slug`	`entity.slug`	-
`summary`	`entity.description`	`stripHtml`
`url`	`entity.url`	`safeUrl`
`type`	`entity.type`	-
`current_version.version`	`package.version`	-
`authors.0.name`	`ext.developer`	-
`average_daily_users`	`ext.users`	`toNumber`
`weekly_downloads`	`ext.weeklyDownloads`	`toNumber`
`ratings.average`	`entity.stats.rating`	`toNumber`
`ratings.count`	`entity.stats.ratingCount`	`toNumber`
`created`	`content.createdAt`	`toIsoDate`
`last_updated`	`content.updatedAt`	`toIsoDate`
`categories`	`entity.tags`	-
`icon_url`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes 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 hour 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#

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`	Unknown endpoint path.
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).