mastodon.timeline_local

stable Advanced

Local timeline of an instance (anonymous access).

GET /v1/mastodon/timeline_local

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 fosstodon.org	max 253 chars; must match `[a-z0-9.-]{3,253}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/mastodon/timeline_local" \
  -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": [
    {
      "content": {
        "id": "117350401495439837",
        "url": "https://fosstodon.org/@altstore/117350401495439837",
        "text": "RE: https:// explore.alt.store/@zoetheinter n/117348663704752862 First is Fundial ⌚️ The most requested feature from every Apple Watch user is finally here: Fundial lets you use custom watch faces on your Apple Watch for the first time EVER! Thanks to Steve Troughton-Smith for showing this was possible (8 years ago!): https:// github.com/steventroughtonsmit h/SpriteKitWatchFace",
        "createdAt": "2026-09-28T19:50:22Z",
        "language": "en"
      },
      "author": {
        "id": "109740010272184248",
        "username": "altstore",
        "displayName": "AltStore",
        "url": "https://fosstodon.org/@altstore",
        "avatarUrl": "https://cdn.fosstodon.org/accounts/avatars/109/740/010/272/184/248/original/11049f6d7ff9f4bb.png"
      },
      "engagement": {
        "likes": 0,
        "comments": 0,
        "shares": 0
      }
    },
    {
      "content": {
        "id": "117350400539772716",
        "url": "https://fosstodon.org/@adingbatponder/117350400539772716",
        "text": "# telekom send me an email saying I can buy the new iphone ... and the link does not work. There is clearly something working well.",
        "createdAt": "2026-09-28T19:50:08Z",
        "language": "en"
      },
      "author": {
        "id": "109293365754542610",
        "username": "adingbatponder",
        "displayName": "adingbatponder :nixos: 👾",
        "url": "https://fosstodon.org/@adingbatponder",
        "avatarUrl": "https://cdn.fosstodon.org/accounts/avatars/109/293/365/754/542/610/original/3a98e6f01b1b165e.jpg"
      },
      "engagement": {
        "likes": 0,
        "comments": 0,
        "shares": 0
      }
    }
  ],
  "metadata": {
    "platform": "mastodon",
    "endpoint": "timeline_local",
    "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`	`content.id`	-
`url`	`content.url`	`safeUrl`
`content`	`content.text`	`stripHtml`
`created_at`	`content.createdAt`	`toIsoDate`
`language`	`content.language`	-
`account.id`	`author.id`	-
`account.username`	`author.username`	-
`account.display_name`	`author.displayName`	-
`account.url`	`author.url`	`safeUrl`
`account.avatar`	`author.avatarUrl`	`safeUrl`
`favourites_count`	`engagement.likes`	`toNumber`
`replies_count`	`engagement.comments`	`toNumber`
`reblogs_count`	`engagement.shares`	`toNumber`

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 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).