Docs
View as Markdown

lemmy.search_posts

stable Advanced

Search Lemmy posts.

GET /v1/lemmy/search_posts

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.

Also works with: Multi-platform search as the Lemmy search leg. Any batch can include it.

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
qstringyes(required)Search querymax 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/lemmy/search_posts?q=python" \
  -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": "38004136",
        "title": "Python Foundation rejects $1.5M grant from NSF with \"no-DEI\" strings",
        "text": "National Science Foundation (NSF) had offered $1.5 million to address structural vulnerabilities in Python and the Python Package Index (PyPI), but the Foundation quickly became dispirited with the terms of the grant it would have to follow. \n\n\"These terms included affirming the statement that we 'do not, and will not during the term of this financial assistance award, operate any programs that advance or promote DEI [diversity, equity, and inclusion], or discriminatory equity ideology in violation of Federal anti-discrimination laws,'\" Crary noted. \"This restriction would apply not only to the security work directly funded by the grant, but to any and all activity of the PSF as a whole.\"",
        "url": "https://www.theregister.com/2025/10/27/python_foundation_abandons_15m_nsf/",
        "createdAt": "2025-10-28T20:20:31Z"
      },
      "ext": {
        "apUrl": "https://lemmy.ca/post/54183496",
        "languageId": 37,
        "title": "Technology"
      },
      "author": {
        "id": "542743",
        "username": "brianpeiris",
        "displayName": null,
        "url": "https://lemmy.ca/u/brianpeiris",
        "avatarUrl": null
      },
      "entity": {
        "name": "technology"
      },
      "engagement": {
        "likes": 1480,
        "comments": 144
      }
    },
    {
      "content": {
        "id": "3474566",
        "title": "Do they also know C++ or Python?",
        "text": null,
        "url": "https://lemmus.org/pictrs/image/9044b87f-bd10-4ee1-bd45-a5a63bd8f8fa.webp",
        "createdAt": "2023-08-20T03:25:36Z"
      },
      "ext": {
        "apUrl": "https://lemmus.org/post/382375",
        "languageId": 0,
        "title": "Lemmy Shitpost"
      },
      "author": {
        "id": "1113518",
        "username": "jimmydoreisalefty",
        "displayName": "jimmydoreisalefty",
        "url": "https://lemmus.org/u/jimmydoreisalefty",
        "avatarUrl": "https://lemmus.org/pictrs/image/2d44d929-f4b8-49a0-ae00-82c5b736e068.webp"
      },
      "entity": {
        "name": "lemmyshitpost"
      },
      "engagement": {
        "likes": 1353,
        "comments": 158
      }
    }
  ],
  "metadata": {
    "platform": "lemmy",
    "endpoint": "search_posts",
    "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).