# amo.addon

**stable** **Standard**

Firefox add-on details by slug or id (AMO).

`GET /v1/amo/addon`

## What you get

One Amo 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

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `slug` | string | yes | (required) | Add-on slug or numeric id, e.g. ublock-origin | max 100 chars; must match `[A-Za-z0-9][A-Za-z0-9_.-]{0,99}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/amo/addon?slug=ublock-origin" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/amo/addon",
    params={"slug": "ublock-origin"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ slug: "ublock-origin" });
const res = await fetch(`https://api.onekey.dev/v1/amo/addon?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": "607454",
      "name": {
        "en-US": "uBlock Origin"
      },
      "slug": "ublock-origin",
      "url": "https://addons.mozilla.org/en-US/firefox/addon/ublock-origin/",
      "type": "extension",
      "stats": {
        "rating": 4.8013,
        "ratingCount": 22153
      },
      "tags": [
        "privacy-security"
      ],
      "description": {
        "en-US": "uBlock Origin is <strong>not</strong> an \"ad blocker\", it's a wide-spectrum content blocker with CPU and memory efficiency as a primary feature.\n\n\n\nOut of the box, uBO blocks ads, trackers, coin miners, popups, etc. through the following lists of filters, enabled by default:\n<ul><li>EasyList (ads)</li><li>EasyPrivacy (tracking)</li><li>Peter Lowe’s Ad server list (ads and tracking)</li><li>Online Malicious URL Blocklist</li><li>uBO's own lists</li></ul>\nMore lists are available for you to select if you wish:\n<ul><li>EasyList Cookie</li><li>Fanboy Annoyances</li><li>AdGuard Annoyances</li><li>Dan Pollock’s hosts file</li><li>And many others</li></ul>\nAdditionally, you can point-and-click to block JavaScript locally or globally, create your own global or local rules to override entries from filter lists, and many more advanced features.\n\n\n\nFree.\nOpen source with public license (GPLv3)\nFor users by users.\n\nIf ever you really do want to contribute something, think about the people working hard to maintain the filter lists you are using, which were made available to use by all for free.\n\n\n<ul><li><a href=\"https://prod.outgoing.prod.webservices.mozgcp.net/v1/788d66e7299bdfb1da05832994551640d0ad441e148a3e29afe8dd0a5a90800c/https%3A//github.com/gorhill/uBlock%23ublock-origin\" rel=\"nofollow\">Documentation</a></li><li><a href=\"https://prod.outgoing.prod.webservices.mozgcp.net/v1/de148deb19b52874eb4c5726859834f3294a6057ed44e873c958acee4c920062/https%3A//github.com/gorhill/uBlock/releases\" rel=\"nofollow\">Release notes</a></li><li><a href=\"https://prod.outgoing.prod.webservices.mozgcp.net/v1/32c3d6819f5263e56c265042e8d34e2da4d974e73a7ad55a81786d8995cf65a9/https%3A//www.reddit.com/r/uBlockOrigin/\" rel=\"nofollow\">Community support @ Reddit</a></li><li><a href=\"https://prod.outgoing.prod.webservices.mozgcp.net/v1/9bfaba4f3fe3310ae0a3189187f5fbab185097d85398752765e086889775079e/https%3A//github.com/gorhill/uBlock/graphs/contributors\" rel=\"nofollow\">Contributors @ GitHub</a></li><li><a href=\"https://prod.outgoing.prod.webservices.mozgcp.net/v1/6a44868e1580018df8d4d87adf8e97cc74b71b962a73dd5a64604f99db767287/https%3A//crowdin.net/project/ublock\" rel=\"nofollow\">Contributors @ Crowdin</a></li></ul>"
      }
    },
    "ext": {
      "entitySummary": {
        "en-US": "Finally, an efficient wide-spectrum content blocker. Easy on CPU and memory."
      },
      "developer": "Raymond Hill",
      "users": 11148991,
      "weeklyDownloads": 233217
    },
    "package": {
      "version": "1.75.0"
    },
    "content": {
      "createdAt": "2015-04-25T07:26:22Z",
      "updatedAt": "2026-09-26T16:26:20Z"
    },
    "media": {
      "thumbnailUrl": "https://addons.mozilla.org/user-media/addon_icons/607/607454-64.png?modified=mcrushed"
    }
  },
  "metadata": {
    "platform": "amo",
    "endpoint": "addon",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `name` | `entity.name` | - |
| `slug` | `entity.slug` | - |
| `summary` | `ext.entitySummary` | `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` |
| `description` | `entity.description` | `stripHtml` |

## 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

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).