lemmy.site

stable Standard

Lemmy instance information.

GET /v1/lemmy/site

What you get#

One Lemmy 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 Lemmy instance (allowlisted), default lemmy.world	max 253 chars; must match `[a-z0-9.-]{3,253}`; trimmed, lowercased

Request#

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

json

{
  "success": true,
  "data": {
    "entity": {
      "name": "Lemmy.World"
    },
    "content": {
      "text": "The World's Internet Frontpage  \nLemmy.World is a general-purpose Lemmy instance of various topics, for the entire world to use.\n\nBe polite and follow the rules ⚖ \nhttps://legal.lemmy.world/tos\n\n## Get started \nSee the [Getting Started Guide](https://support.lemmy.world/quickstart)\n\n## Donations 💗\nIf you would like to make a donation to support the cost of running this platform, please do so at the following donation URLs.\n\n**If you can, please use / switch to Ko-Fi, it has the lowest fees for us**\n\n[![Ko-Fi (Donate)](https://img.shields.io/badge/KoFi_Donate-FHFWorld-red?style=flat-square&logo=kofi&color=red)](https://ko-fi.com/fhfworld)\n\n[![Bunq (Donate)](https://img.shields.io/badge/Bunq_Donate-FHF-green?style=flat-square&logo=bunq&color=darkgreen)](https://bunq.me/fhf)\n\n[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/mastodonworld?style=flat-square&logo=opencollective&color=7FADF2)](https://opencollective.com/mastodonworld)\n\n[![Patreon](https://img.shields.io/badge/Patreon-MastodonWorld-green?style=flat-square&logo=patreon&color=lightblue)](https://patreon.com/mastodonworld)\n\n[![Liberapay patrons](https://img.shields.io/liberapay/patrons/fhf?style=flat-square&logo=liberapay)](https://en.liberapay.com/fhf)\n\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/Fedihosting-Foundation?style=flat-square&logo=github&label=Sponsors)](https://github.com/sponsors/Fedihosting-Foundation)\n\n## Join the team 😎\n[Check out our team page to join](h",
      "title": "A generic Lemmy server for everyone to use."
    },
    "media": {
      "thumbnailUrl": "https://lemmy.world/pictrs/image/0fd47927-ca3a-4d2c-b2e4-a25353786671.png"
    },
    "ext": {
      "users": 198927,
      "posts": 781220
    },
    "engagement": {
      "comments": 7092952
    },
    "package": {
      "version": "0.19.19-9-gc55dd700c"
    }
  },
  "metadata": {
    "platform": "lemmy",
    "endpoint": "site",
    "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. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`site_view.site.name`	`entity.name`	-
`site_view.site.sidebar`	`content.text`	-
`site_view.site.description`	`content.title`	-
`site_view.site.icon`	`media.thumbnailUrl`	`safeUrl`
`site_view.counts.users`	`ext.users`	`toNumber`
`site_view.counts.posts`	`ext.posts`	`toNumber`
`site_view.counts.comments`	`engagement.comments`	`toNumber`
`version`	`package.version`	-

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; 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 for the full list and retry guidance.

Status: stable (verified against the live source).