# lemmy.community

**stable** **Standard**

A Lemmy community.

`GET /v1/lemmy/community`

## 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 |
| `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/community?name=technology" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/lemmy/community",
    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/community?${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": "2478",
      "title": "Technology",
      "text": "This is a [most excellent](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExN3N0NmhuODNib3d3Nzg0OHU2bTFqMXAzNW42Y2JsOTVmenNsNG8ycSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/l46CDHTqbmnGZyxKo/giphy.gif) place for technology news and articles.\n \n---\n \n## Our Rules\n \n---\n \n1. Follow the [lemmy.world rules.](https://mastodon.world/about) \n2. Only tech related news or articles.\n3. Be [excellent to each other!](https://www.youtube.com/watch?v=rph_1DODXDU)\n4. Mod approved content bots can post up to 10 articles per day.\n5. Threads asking for personal tech support may be deleted.\n6. Politics threads may be removed.\n7. No memes allowed as posts, OK to post as comments.\n8. Only approved bots from the list below, this includes using AI responses and summaries. To ask if your bot can be added please contact a mod.\n9. Check for duplicates before posting, duplicates may be removed\n10. Accounts 7 days and younger will have their posts automatically removed. \n \n---\n \n## Approved Bots\n \n---\n \n- [@L4s@lemmy.world](https://lemmy.world/u/L4s) \n- [@autotldr@lemmings.world](https://lemmings.world/u/autotldr) \n- [@PipedLinkBot@feddit.rocks](https://feddit.rocks/u/PipedLinkBot) \n- [@wikibot@lemmy.world](https://lemmy.world/u/wikibot) ",
      "createdAt": "2023-06-11T02:16:17Z"
    },
    "entity": {
      "name": "technology",
      "url": "https://lemmy.world/c/technology",
      "stats": {
        "followers": 88298
      }
    },
    "media": {
      "thumbnailUrl": "https://lemmy.world/pictrs/image/2a85bf08-5c07-4326-8dad-f549bfb2189e.png"
    },
    "ext": {
      "posts": 21955
    },
    "engagement": {
      "comments": 959056
    }
  },
  "metadata": {
    "platform": "lemmy",
    "endpoint": "community",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `community_view.community.id` | `content.id` | `toString` |
| `community_view.community.name` | `entity.name` | - |
| `community_view.community.title` | `content.title` | - |
| `community_view.community.description` | `content.text` | - |
| `community_view.community.actor_id` | `entity.url` | `safeUrl` |
| `community_view.community.icon` | `media.thumbnailUrl` | `safeUrl` |
| `community_view.community.published` | `content.createdAt` | `toIsoDate` |
| `community_view.counts.subscribers` | `entity.stats.followers` | `toNumber` |
| `community_view.counts.posts` | `ext.posts` | `toNumber` |
| `community_view.counts.comments` | `engagement.comments` | `toNumber` |

## Caching and freshness

- Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
- Between 30 minutes and 6 hours 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 day 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).