# lemmy.posts_top

**stable** **Advanced**

Top posts of a Lemmy community (past week).

`GET /v1/lemmy/posts_top`

## 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

| 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 |
| `name` | string | yes | (required) | Community name without instance, e.g. technology | max 100 chars; must match `[A-Za-z0-9_]{1,100}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/lemmy/posts_top?name=technology" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/lemmy/posts_top",
    params={"name": "technology"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ name: "technology" });
const res = await fetch(`https://api.onekey.dev/v1/lemmy/posts_top?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": "52216336",
        "title": "Meta Now Banning Ads That Promote Feminism: \"We have given social media unlimited power and every day we can see how dangerous this is.\"",
        "text": "",
        "url": "https://futurism.com/artificial-intelligence/meta-banning-ads-virginia-woolf-facebook-instagram-feminism",
        "createdAt": "2026-09-22T05:58:06Z"
      },
      "ext": {
        "apUrl": "https://lemmy.world/post/52216336",
        "languageId": 37,
        "title": "Technology"
      },
      "author": {
        "id": "23311182",
        "username": "eicker",
        "displayName": null,
        "url": "https://lemmy.world/u/eicker",
        "avatarUrl": "https://lemmy.world/pictrs/image/8ecb16d0-790b-49ce-bb62-4770f7650efe.webp"
      },
      "entity": {
        "name": "technology"
      },
      "engagement": {
        "likes": 977,
        "comments": 200
      }
    },
    {
      "content": {
        "id": "52326171",
        "title": "F-Droid gets its biggest update in a decade with new UI and smoother app installs",
        "text": null,
        "url": "https://arstechnica.com/gadgets/2026/09/f-droid-gets-its-biggest-update-in-a-decade-with-new-ui-and-smoother-app-installs/",
        "createdAt": "2026-09-24T21:28:33Z"
      },
      "ext": {
        "apUrl": "https://lemmy.world/post/52326171",
        "languageId": 37,
        "title": "Technology"
      },
      "author": {
        "id": "580006",
        "username": "return2ozma",
        "displayName": null,
        "url": "https://lemmy.world/u/return2ozma",
        "avatarUrl": "https://lemmy.world/pictrs/image/d3a9d820-8565-42fc-934b-ed38e2b5f96e.jpeg"
      },
      "entity": {
        "name": "technology"
      },
      "engagement": {
        "likes": 965,
        "comments": 165
      }
    }
  ],
  "metadata": {
    "platform": "lemmy",
    "endpoint": "posts_top",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `post.id` | `content.id` | `toString` |
| `post.name` | `content.title` | - |
| `post.body` | `content.text` | - |
| `post.url` | `content.url` | `safeUrl` |
| `post.ap_id` | `ext.apUrl` | `safeUrl` |
| `post.published` | `content.createdAt` | `toIsoDate` |
| `post.language_id` | `ext.languageId` | `toNumber` |
| `creator.id` | `author.id` | `toString` |
| `creator.name` | `author.username` | - |
| `creator.display_name` | `author.displayName` | - |
| `creator.actor_id` | `author.url` | `safeUrl` |
| `creator.avatar` | `author.avatarUrl` | `safeUrl` |
| `community.name` | `entity.name` | - |
| `community.title` | `ext.title` | - |
| `counts.score` | `engagement.likes` | `toNumber` |
| `counts.comments` | `engagement.comments` | `toNumber` |

## 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
