mastodon.directory

stable Advanced

Profile directory of an instance.

GET /v1/mastodon/directory

What you get#

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

Request#

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

json

{
  "success": true,
  "data": [
    {
      "author": {
        "id": "414322",
        "username": "steveriggins",
        "displayName": "Steve Riggins",
        "url": "https://mastodon.social/@steveriggins",
        "avatarUrl": "https://files.mastodon.social/accounts/avatars/000/414/322/original/01fb5d520ccf7d0f.jpeg",
        "followers": 687,
        "following": 542
      },
      "content": {
        "text": "iOS engineer at eBay. He/Him. Started my career in the 80s at The Voyager Company working on laserdisc and CD-ROM interfaced HyperCard stacks. Shipped QuickTime video at launch. Bad puns are the best. All posts are mine and do not represent my employer.",
        "createdAt": "2018-08-11T00:00:00Z"
      },
      "engagement": {
        "comments": 12878
      }
    },
    {
      "author": {
        "id": "110515929245243774",
        "username": "FrostyX",
        "displayName": "FrostyX :redhat:",
        "url": "https://fosstodon.org/@FrostyX",
        "avatarUrl": "https://files.mastodon.social/cache/accounts/avatars/110/515/929/245/243/774/original/b5a41d358ad04541.jpeg",
        "followers": 188,
        "following": 40
      },
      "content": {
        "text": "I am a computer nerd (read software engineer) way too much interested in Emacs, RPM packaging ecosystem, and Free software (as in freedom) in general. :fedora: :redhat: :python: :emacs:",
        "createdAt": "2023-06-02T00:00:00Z"
      },
      "engagement": {
        "comments": 459
      }
    }
  ],
  "metadata": {
    "platform": "mastodon",
    "endpoint": "directory",
    "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`	`author.id`	-
`username`	`author.username`	-
`display_name`	`author.displayName`	-
`url`	`author.url`	`safeUrl`
`avatar`	`author.avatarUrl`	`safeUrl`
`note`	`content.text`	`stripHtml`
`followers_count`	`author.followers`	`toNumber`
`following_count`	`author.following`	`toNumber`
`statuses_count`	`engagement.comments`	`toNumber`
`created_at`	`content.createdAt`	`toIsoDate`

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