> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/lemmy/community/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/lemmy/community/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Lemmy community (https://www.socialfetch.dev/docs/api/v1/lemmy/community/get)

## Summary

Get one Lemmy community with its counts, active users and moderators.

**Tags:** `Lemmy`

## HTTP

- **Method:** GET
- **Path:** `/v1/lemmy/community`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.lemmy.getCommunity({ instance: "lemmy.world", name: "technology" })`
- **Accepted identifiers:** `id` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `private`, `not_compatible`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `instance` (query)

- **Required:** yes
- **Constraints:** type `string`
- **Description:** The Lemmy instance, e.g. `lemmy.world`. A URL on the instance is also accepted. Ids and counts belong to this instance.

### `name` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Community name, e.g. `technology`, or `technology@lemmy.world` to resolve a community on another instance. Prefer the community's home instance for counts.

### `id` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 2147483647
- **Description:** Community id on the chosen instance, e.g. `2478`.

## Responses (status codes)

- **200**: Community.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Community.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found, private, not_compatible. `found`, `not_found` (the entity is missing, or the host name does not resolve), `private` (the instance does not allow public lists) or `not_compatible` (the host is not a Lemmy instance, or its version does not serve this operation). See `reason`.
  - **instance** (required) — type `string`. The instance that was asked.
  - **reason** (required) — type `object`; nullable. Why `lookupStatus` is not `found`, or null when it is `found`.
    - **code** (required) — type `string`; enum: instance_private, not_a_lemmy_instance, not_available, deleted, host_not_found. Machine-readable reason.
    - **message** (required) — type `string`. Plain-language explanation.
  - **community** (required) — type `object`; nullable. The community when `lookupStatus` is `found`; otherwise null.
    - **id** (required) — type `integer`. Community id on this instance.
    - **name** (required) — type `string`. Community name without the host.
    - **title** (required) — type `string`; nullable. Display title.
    - **actorId** (required) — type `string`; nullable. Canonical ActivityPub id.
    - **host** (required) — type `string`; nullable. Host the community lives on.
    - **handle** (required) — type `string`; nullable. `name@host`.
    - **icon** (required) — type `string`; nullable. Community icon URL.
    - **nsfw** (required) — type `boolean`; nullable. Whether the community is NSFW.
    - **isLocal** (required) — type `boolean`; nullable. Whether the community lives on the instance asked.
    - **description** (required) — type `string`; nullable. Description as Markdown.
    - **banner** (required) — type `string`; nullable. Banner URL.
    - **publishedAt** (required) — type `string`; nullable. When the community was created.
    - **updatedAt** (required) — type `string`; nullable. When the community last changed.
    - **removed** (required) — type `boolean`; nullable. Whether a moderator removed the community.
    - **deleted** (required) — type `boolean`; nullable. Whether the community was deleted.
    - **hidden** (required) — type `boolean`; nullable. Whether the community is hidden.
    - **postingRestrictedToMods** (required) — type `boolean`; nullable. Whether only moderators may post.
    - **visibility** (required) — type `string`; nullable. `Public` or another visibility the instance reports.
    - **subscriberCount** (required) — type `integer`; nullable. Subscribers.
    - **localSubscriberCount** (required) — type `integer`; nullable. Subscribers on the community's own instance.
    - **postCount** (required) — type `integer`; nullable. Posts in the community.
    - **commentCount** (required) — type `integer`; nullable. Comments in the community.
    - **activeUsers** (required) — type `object`; nullable. Active users in the community.
      - **day** (required) — type `integer`; nullable. Active users today.
      - **week** (required) — type `integer`; nullable. Active users this week.
      - **month** (required) — type `integer`; nullable. Active users this month.
      - **halfYear** (required) — type `integer`; nullable. Active users in the last six months.
    - **moderators** (required) — type `array`; nullable. Moderators; null on list rows, which do not carry them.
      - _items:_
    - **languageIds** (required) — type `array`; nullable. Discussion language ids; null on rows that do not carry them. The instance endpoint maps ids to language codes.
      - _items:_
        - type `integer`
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "instance": "lemmy.world",
    "reason": null,
    "community": {
      "id": 2478,
      "name": "technology",
      "title": "Technology",
      "actorId": "https://lemmy.world/c/technology",
      "host": "lemmy.world",
      "handle": "technology@lemmy.world",
      "icon": "https://lemmy.world/pictrs/image/2a85bf08-5c07-4326-8dad-f549bfb2189e.png",
      "nsfw": false,
      "isLocal": true,
      "description": "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://mastodo…",
      "banner": "https://lemmy.world/pictrs/image/be818d42-f96f-4a33-b963-2a6e35938d54.png",
      "publishedAt": "2023-06-11T02:16:17.173Z",
      "updatedAt": "2025-12-29T20:50:24.593Z",
      "removed": false,
      "deleted": false,
      "hidden": false,
      "postingRestrictedToMods": false,
      "visibility": "Public",
      "subscriberCount": 89543,
      "localSubscriberCount": 41510,
      "postCount": 22609,
      "commentCount": 986107,
      "activeUsers": {
        "day": 4925,
        "week": 10067,
        "month": 15387,
        "halfYear": 30056
      },
      "moderators": [
        {
          "id": 319663,
          "name": "L3s",
          "displayName": null,
          "bio": "Technology professional and enthusiast.",
          "avatar": "https://lemmy.world/pictrs/image/ca50d860-0713-4719-b9f6-97e3e6d6f2e8.png",
          "banner": "https://lemmy.world/pictrs/image/27435bcd-da61-42a3-adfe-72697864cf36.png",
          "actorId": "https://lemmy.world/u/L3s",
          "host": "lemmy.world",
          "handle": "L3s@lemmy.world",
          "publishedAt": "2023-06-21T19:41:41.486Z",
          "updatedAt": null,
          "banned": false,
          "banExpiresAt": null,
          "deleted": false,
          "isBot": false,
          "isLocal": true,
          "matrixUserId": "@L3s:matrix.org"
        }
      ],
      "languageIds": [
        37
      ]
    }
  },
  "meta": {
    "requestId": "req_6a452b4a-1f15-498d-87f5-80a0dd6a95eb",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.lemmy.getCommunity({
  instance: "lemmy.world",
  name: "technology",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/lemmy/community?instance=lemmy.world&name=technology",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/lemmy/community?instance=lemmy.world&name=technology" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/lemmy/community?instance=lemmy.world&name=technology",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```