Docs
View as Markdown

lemmy.frontpage

stable Advanced

Hot posts across all Lemmy communities on an instance.

GET /v1/lemmy/frontpage

What you get#

A list of Lemmy 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#

NameTypeRequiredDefaultWhat it isConstraints
instancestringno-Known Lemmy instance (allowlisted), default lemmy.worldmax 253 chars; must match [a-z0-9.-]{3,253}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/lemmy/frontpage" \
  -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": [
    {
      "content": {
        "id": "52481720",
        "title": "Expressions",
        "text": "cross-posted from: https://lemmy.world/post/52447554\n",
        "url": "https://lemmy.world/pictrs/image/83e3192c-0e45-4aa8-a2e4-633e13bad606.png",
        "createdAt": "2026-09-28T19:30:06Z"
      },
      "ext": {
        "apUrl": "https://piefed.social/c/programmer_humor@programming.dev/p/2430234/expressions",
        "languageId": 37,
        "title": "Programmer Humor"
      },
      "author": {
        "id": "19765279",
        "username": "Buage_",
        "displayName": "Buage_",
        "url": "https://piefed.social/u/Buage_",
        "avatarUrl": "https://media.piefed.social/posts/F8/OO/F8OOY6ngWlEPfuh.png"
      },
      "entity": {
        "name": "programmer_humor"
      },
      "engagement": {
        "likes": 23,
        "comments": 0
      }
    },
    {
      "content": {
        "id": "52481502",
        "title": "blunt",
        "text": null,
        "url": "https://lemmy.world/pictrs/image/6f82b2c1-acd4-4d50-9ea7-7ffc5f565b77.jpeg",
        "createdAt": "2026-09-28T19:25:44Z"
      },
      "ext": {
        "apUrl": "https://lemmy.world/post/52481502",
        "languageId": 37,
        "title": "Femcel Memes"
      },
      "author": {
        "id": "1141653",
        "username": "kewwwi",
        "displayName": null,
        "url": "https://lemmy.world/u/kewwwi",
        "avatarUrl": "https://lemmy.world/pictrs/image/2b91ede2-240c-4102-bd4c-e74b2e99bacd.jpeg"
      },
      "entity": {
        "name": "femcelmemes"
      },
      "engagement": {
        "likes": 29,
        "comments": 0
      }
    }
  ],
  "metadata": {
    "platform": "lemmy",
    "endpoint": "frontpage",
    "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 pathOnekey fieldTransform
post.idcontent.idtoString
post.namecontent.title-
post.bodycontent.text-
post.urlcontent.urlsafeUrl
post.ap_idext.apUrlsafeUrl
post.publishedcontent.createdAttoIsoDate
post.language_idext.languageIdtoNumber
creator.idauthor.idtoString
creator.nameauthor.username-
creator.display_nameauthor.displayName-
creator.actor_idauthor.urlsafeUrl
creator.avatarauthor.avatarUrlsafeUrl
community.nameentity.name-
community.titleext.title-
counts.scoreengagement.likestoNumber
counts.commentsengagement.commentstoNumber

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).