> **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/instance/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/lemmy/instance/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 instance (https://www.socialfetch.dev/docs/api/v1/lemmy/instance/get)

## Summary

Get Lemmy instance version, counts, registration and federation settings.

**Tags:** `Lemmy`

## HTTP

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

## Capability summary

- **SDK mapping:** `client.lemmy.getInstance({ instance: "lemmy.world" })`
- **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.

### `include` (query)

- **Required:** no
- **Constraints:** type `array`
- **Description:** Extra heavy parts to return: `emoji`, `blockedUrls`, `taglines`, comma-separated. Default: none; the site object can be megabytes of custom emoji.

## Responses (status codes)

- **200**: Instance.
- **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)

Instance.

### 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.
  - **site** (required) — type `object`; nullable. The site object when `lookupStatus` is `found`.
    - **name** (required) — type `string`. Instance name.
    - **description** (required) — type `string`; nullable. Short description.
    - **sidebar** (required) — type `string`; nullable. Sidebar text as Markdown.
    - **icon** (required) — type `string`; nullable. Icon URL.
    - **banner** (required) — type `string`; nullable. Banner URL.
    - **actorId** (required) — type `string`; nullable. Canonical ActivityPub id.
    - **publishedAt** (required) — type `string`; nullable. When the instance was created.
    - **updatedAt** (required) — type `string`; nullable. When its settings last changed.
    - **host** (required) — type `string`. The instance host.
    - **software** (required) — type `object`. Software and version.
      - **name** (required) — type `string`. `lemmy`.
      - **version** (required) — type `string`; nullable. Version the instance reports.
    - **registration** (required) — type `object`. How the instance handles registration.
      - **mode** (required) — type `string`; nullable. `Open`, `RequireApplication` or `Closed`.
      - **requiresEmail** (required) — type `boolean`; nullable. Whether an email verification is required.
      - **question** (required) — type `string`; nullable. The application question, when registration requires one.
      - **captcha** (required) — type `boolean`; nullable. Whether registration asks for a verification challenge.
    - **isPrivate** (required) — type `boolean`; nullable. Whether the instance is private, so it does not allow public lists.
    - **federationEnabled** (required) — type `boolean`; nullable. Whether federation is on.
    - **downvotesEnabled** (required) — type `boolean`; nullable. Whether downvotes are enabled.
    - **nsfwEnabled** (required) — type `boolean`; nullable. Whether NSFW content is allowed.
    - **communityCreationAdminOnly** (required) — type `boolean`; nullable. Whether only administrators may create communities.
    - **hidesModeratorNames** (required) — type `boolean`; nullable. Whether the modlog hides moderator names.
    - **legalInformation** (required) — type `string`; nullable. Legal information.
    - **defaultSort** (required) — type `string`; nullable. The instance's default sort.
    - **defaultListing** (required) — type `string`; nullable. The instance's default post listing.
    - **limits** (required) — type `object`. The request limits the instance publishes.
      - **search** (required) — type `object`. The instance's own search limit.
    - **stats** (required) — type `object`. Counts the instance publishes.
      - **users** (required) — type `integer`; nullable. Registered users.
      - **posts** (required) — type `integer`; nullable. Posts.
      - **comments** (required) — type `integer`; nullable. Comments.
      - **communities** (required) — type `integer`; nullable. Communities.
      - **activeDay** (required) — type `integer`; nullable. Users active today.
      - **activeWeek** (required) — type `integer`; nullable. Users active this week.
      - **activeMonth** (required) — type `integer`; nullable. Users active this month.
      - **activeHalfYear** (required) — type `integer`; nullable. Users active in the last six months.
    - **admins** (required) — type `array`. Instance administrators with their counts.
      - _items:_
    - **languages** (required) — type `array`. Every language the instance knows.
      - _items:_
    - **discussionLanguages** (required) — type `array`. The languages the instance discusses in.
      - _items:_
    - **taglines** (required) — type `array`; nullable. Taglines; null unless `include=taglines` was asked for.
      - _items:_
    - **customEmojis** (required) — type `array`; nullable. Custom emoji; null unless `include=emoji` was asked for.
      - _items:_
    - **blockedUrls** (required) — type `array`; nullable. URLs the instance blocks from its links; null unless `include=blockedUrls` was asked for.
      - _items:_
        - type `string`
  - **nodeinfo** (required) — type `object`; nullable. The host's NodeInfo document; null when it is not available, in which case `site` is still returned.
    - **software** (required) — type `object`. The software the host reports.
      - **name** (required) — type `string`; nullable. Software name, e.g. `lemmy`.
      - **version** (required) — type `string`; nullable. Software version.
    - **usage** (required) — type `object`. Usage counts.
      - **usersTotal** (required) — type `integer`; nullable. Registered users.
      - **activeHalfYear** (required) — type `integer`; nullable. Active users in six months.
      - **activeMonth** (required) — type `integer`; nullable. Active users in a month.
      - **localPosts** (required) — type `integer`; nullable. Local posts.
      - **localComments** (required) — type `integer`; nullable. Local comments.
    - **openRegistrations** (required) — type `boolean`; nullable. Whether the host reports open registrations.
- **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,
    "site": {
      "name": "Lemmy.World",
      "description": "A generic Lemmy server for everyone to use.",
      "sidebar": "The World's Internet Frontpage  \nLemmy.World is a general-purpose Lemmy instance of various topics, for the entire world to use.\n\nBe polite and follow the rules ⚖ \nhttps://legal.lemmy.world/tos\n\n## Get started \nSee the [Getting Started Gui…",
      "icon": "https://lemmy.world/pictrs/image/0fd47927-ca3a-4d2c-b2e4-a25353786671.png",
      "banner": "https://lemmy.world/pictrs/image/d22b2935-f27b-49f0-81e7-c81c21088467.png",
      "actorId": "https://lemmy.world/",
      "publishedAt": "2023-06-01T07:01:46.127Z",
      "updatedAt": "2026-08-11T23:41:11.606Z",
      "host": "lemmy.world",
      "software": {
        "name": "lemmy",
        "version": "0.19.21-8-g081ada9cf"
      },
      "registration": {
        "mode": "RequireApplication",
        "requiresEmail": true,
        "question": "`Welcome to Lemmy.World!`\n\n**Please agree to our [Terms of Service (TOS)](https://legal.lemmy.world) and [Privacy Policy](https://legal.lemmy.world/privacy-policy/) by typing `I agree to the TOS` in the form below. If you do not, your regi…",
        "captcha": true
      },
      "isPrivate": false,
      "federationEnabled": true,
      "downvotesEnabled": true,
      "nsfwEnabled": true,
      "communityCreationAdminOnly": false,
      "hidesModeratorNames": false,
      "legalInformation": "## Lemmy.World Legal Info\nhttps://legal.lemmy.world\n\n## Lemmy.World Support\nVisit our support page here: https://support.lemmy.world\n\n## Report Issues/Contact Us\nContact us for all issues by e-mailing info@lemmy.world.\n\nInterested in knowi…",
      "defaultSort": "Active",
      "defaultListing": "All",
      "limits": {
        "search": {
          "requests": 100,
          "windowSeconds": 600
        }
      },
      "stats": {
        "users": 201378,
        "posts": 804854,
        "comments": 7267246,
        "communities": 13713,
        "activeDay": 6345,
        "activeWeek": 9319,
        "activeMonth": 12975,
        "activeHalfYear": 22641
      },
      "admins": [
        {
          "id": 2,
          "name": "ruud",
          "displayName": "Ruud",
          "bio": "Admin of a lot of fediverse servers.\nSee my accounts on [Keyoxide](https://keyoxide.world/hkp/0BCE3A7061CF0D42952A3A985CB7103EFB4C95CF)\n\nI receive a lot of messages, direct and mentions. I can't reply to them all.\nIf you have an issue, ple…",
          "avatar": "https://lemmy.world/pictrs/image/2f75baeb-34c1-4a8b-8d1e-bc0a52b47a62.png",
          "banner": "https://lemmy.world/pictrs/image/2cddd018-5a89-4427-963a-025594190857.png",
          "actorId": "https://lemmy.world/u/ruud",
          "host": "lemmy.world",
          "handle": "ruud@lemmy.world",
          "publishedAt": "2023-06-01T07:01:45.388Z",
          "updatedAt": null,
          "banned": false,
          "banExpiresAt": null,
          "deleted": false,
          "isBot": false,
          "isLocal": true,
          "matrixUserId": "@ruud:lemmy.world",
          "postCount": 128,
          "commentCount": 997,
          "postScore": null,
          "commentScore": null,
          "isAdmin": true,
          "moderates": null
        }
      ],
      "languages": [
        {
          "id": 0,
          "code": "und",
          "name": "Undetermined"
        }
      ],
      "discussionLanguages": [
        {
          "id": 0,
          "code": "und",
          "name": "Undetermined"
        }
      ],
      "taglines": null,
      "customEmojis": null,
      "blockedUrls": null
    },
    "nodeinfo": {
      "software": {
        "name": "lemmy",
        "version": "0.19.21-8-g081ada9cf"
      },
      "usage": {
        "usersTotal": 201378,
        "activeHalfYear": 22641,
        "activeMonth": 12975,
        "localPosts": 804854,
        "localComments": 7267246
      },
      "openRegistrations": true
    }
  },
  "meta": {
    "requestId": "req_0b5f1034-ba52-42d0-954c-cbaddf4564f7",
    "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.getInstance({
  instance: "lemmy.world",
});

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/instance?instance=lemmy.world",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

### cURL

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

### Python

```python
import requests

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