# mastodon.instance

**stable** **Standard**

Instance information (v2).

`GET /v1/mastodon/instance`

## What you get

One Mastodon 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 |
| --- | --- | --- | --- | --- | --- |
| `instance` | string | no | - | Known Mastodon instance (allowlisted), default mastodon.social | max 253 chars; must match `[a-z0-9.-]{3,253}`; trimmed, lowercased |

## Request

```bash
curl "https://api.onekey.dev/v1/mastodon/instance" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/mastodon/instance",
    params={},
    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({});
const res = await fetch(`https://api.onekey.dev/v1/mastodon/instance?${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 Mastodon response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "entity": {
      "name": "mastodon.social"
    },
    "content": {
      "title": "Mastodon",
      "text": "The original server of Mastodon, operated by Mastodon GmbH for the common good.",
      "language": "en"
    },
    "package": {
      "version": "4.8.0-alpha.3+pr-40283-7f6b1dc"
    },
    "ext": {
      "activeMonth": 269121,
      "contact": "staff@mastodon.social",
      "registrationsOpen": true
    },
    "media": {
      "thumbnailUrl": "https://files.mastodon.social/site_uploads/files/000/000/001/@1x/57c12f441d083cde.png"
    }
  },
  "metadata": {
    "platform": "mastodon",
    "endpoint": "instance",
    "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 |
| --- | --- | --- |
| `domain` | `entity.name` | - |
| `title` | `content.title` | - |
| `description` | `content.text` | `stripHtml` |
| `version` | `package.version` | - |
| `usage.users.active_month` | `ext.activeMonth` | `toNumber` |
| `languages.0` | `content.language` | - |
| `contact.email` | `ext.contact` | - |
| `thumbnail.url` | `media.thumbnailUrl` | `safeUrl` |
| `registrations.enabled` | `ext.registrationsOpen` | `toBoolean` |

## 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 2 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](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).