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

---
# Search Lemmy instance (https://www.socialfetch.dev/docs/api/v1/lemmy/search/get)

## Summary

Search Lemmy posts, comments, communities, users or exact URLs; All and Comments can take longer.

**Tags:** `Lemmy`

## HTTP

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

## Capability summary

- **SDK mapping:** `client.lemmy.search({ instance: "lemmy.world", query: "linux", type: "Posts" })`
- **Accepted identifiers:** `query` (query), `author` (query)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **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.

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 300
- **Description:** Search term, 1 to 300 characters, in any language. Required, never empty and no control characters.

### `type` (query)

- **Required:** no
- **Constraints:** type `string`; enum: All, Comments, Posts, Communities, Users, Url
- **Description:** `Posts` (default), `All` (every kind), `Comments` (comment text), `Communities`, `Users` or `Url` (posts linking to an exact URL). `All` and `Comments` can take much longer than the other kinds.

### `sort` (query)

- **Required:** no
- **Constraints:** type `string`; enum: Active, Hot, New, Old, TopHour, TopSixHour, TopTwelveHour, TopDay, TopWeek, TopMonth, TopThreeMonths, TopSixMonths, TopNineMonths, TopYear, TopAll, MostComments, NewComments, Controversial, Scaled
- **Description:** Order. `Scaled` and `Controversial` are refused by 0.18 instances.

### `community` (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.

### `author` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Restrict to one author, by username.

### `scope` (query)

- **Required:** no
- **Constraints:** type `string`; enum: local, all
- **Description:** `local` reads only this instance's own items; `all` includes federated items the instance has seen. Default: the endpoint's own listing.

### `page` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 100
- **Description:** Page number, 1 to 100. Default: 1. An instance refuses pages past 100. Lemmy pages by number over a live order, so new or re-ranked items can shift a row onto the next page. Remove repeats by `id`.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 2048
- **Description:** Pass `page.nextCursor` from the previous response to get the next page. It only works with the same filters; do not send it with `page`.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 50
- **Description:** Rows per page, 1 to 50. Default: 10.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

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

Search results.

### 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.
  - **type** (required) — type `string`; nullable. The result kind, as Lemmy names it.
  - **posts** (required) — type `array`. Matching posts.
    - _items:_
      - **id** (required) — type `integer`. Post id on this instance.
      - **apId** (required) — type `string`; nullable. Canonical ActivityPub id.
      - **title** (required) — type `string`; nullable. Post title.
      - **url** (required) — type `string`; nullable. Link the post points at; null for a text post.
      - **urlContentType** (required) — type `string`; nullable. Content type of the link.
      - **thumbnailUrl** (required) — type `string`; nullable. Thumbnail URL.
      - **nsfw** (required) — type `boolean`; nullable. Whether the post is NSFW.
      - **locked** (required) — type `boolean`; nullable. Whether the post is locked.
      - **removed** (required) — type `boolean`; nullable. Whether a moderator removed it.
      - **deleted** (required) — type `boolean`; nullable. Whether it was deleted.
      - **publishedAt** (required) — type `string`; nullable. When it was posted.
      - **updatedAt** (required) — type `string`; nullable. When it last changed.
      - **languageId** (required) — type `integer`; nullable. Discussion language id.
      - **isLocal** (required) — type `boolean`; nullable. Whether it was posted on the instance asked.
      - **score** (required) — type `integer`; nullable. Votes up minus votes down.
      - **upvotes** (required) — type `integer`; nullable. Upvotes.
      - **downvotes** (required) — type `integer`; nullable. Downvotes.
      - **commentCount** (required) — type `integer`; nullable. Comments on the post.
      - **community** (required) — type `object`. The community it was posted in, with the counts the single-post answer carries.
      - **author** (required) — type `object`; nullable. Who posted it; null on a modlog row, which does not carry the creator.
      - **body** (required) — type `string`; nullable. Post text as Markdown.
      - **embed** (required) — type `object`; nullable. Link preview; null when the instance found none.
      - **altText** (required) — type `string`; nullable. Alt text for the image.
      - **image** (required) — type `object`; nullable. Image details; null when the post has no image.
      - **featuredInCommunity** (required) — type `boolean`; nullable. Whether it is featured in its community.
      - **featuredOnInstance** (required) — type `boolean`; nullable. Whether it is featured on the instance.
      - **newestCommentAt** (required) — type `string`; nullable. When the newest comment was made.
      - **isAdmin** (required) — type `boolean`; nullable. Whether the author is an instance administrator.
      - **isModerator** (required) — type `boolean`; nullable. Whether the author moderates the community.
      - **bannedFromCommunity** (required) — type `boolean`; nullable. Whether the author is banned from the community.
      - **crossPosts** (required) — type `array`; nullable. Posts of the same link in other communities; null on list rows.
        - _items:_
      - **moderators** (required) — type `array`; nullable. Moderators of the community; null on list rows, which do not carry them.
        - _items:_
  - **comments** (required) — type `array`. Matching comments.
    - _items:_
      - **id** (required) — type `integer`. Comment id on this instance.
      - **apId** (required) — type `string`; nullable. Canonical ActivityPub id.
      - **content** (required) — type `string`; nullable. Comment text as Markdown; empty when a moderator removed it or its author deleted it.
      - **postId** (required) — type `integer`; nullable. The post it belongs to.
      - **path** (required) — type `string`; nullable. The dotted ancestor chain, from the root post (`0.1234.5678`).
      - **depth** (required) — type `integer`; nullable. Depth in the tree, from `path`.
      - **parentId** (required) — type `integer`; nullable. The comment it replies to; null for a top-level comment.
      - **distinguished** (required) — type `boolean`; nullable. Whether a moderator marked it as a moderator comment.
      - **languageId** (required) — type `integer`; nullable. Discussion language id.
      - **isLocal** (required) — type `boolean`; nullable. Whether it was written on the instance asked.
      - **removed** (required) — type `boolean`; nullable. Whether a moderator removed it.
      - **deleted** (required) — type `boolean`; nullable. Whether its author deleted it.
      - **publishedAt** (required) — type `string`; nullable. When it was written.
      - **updatedAt** (required) — type `string`; nullable. When it last changed.
      - **score** (required) — type `integer`; nullable. Votes up minus votes down.
      - **upvotes** (required) — type `integer`; nullable. Upvotes.
      - **downvotes** (required) — type `integer`; nullable. Downvotes.
      - **replyCount** (required) — type `integer`; nullable. Direct replies.
      - **isAdmin** (required) — type `boolean`; nullable. Whether the author is an instance administrator.
      - **isModerator** (required) — type `boolean`; nullable. Whether the author moderates the community.
      - **bannedFromCommunity** (required) — type `boolean`; nullable. Whether the author is banned from the community.
      - **post** (required) — type `object`. The post it belongs to.
      - **community** (required) — type `object`. The community of the post.
      - **author** (required) — type `object`. Who wrote it.
  - **communities** (required) — type `array`. Matching communities.
    - _items:_
      - **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.
      - **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`
  - **users** (required) — type `array`. Matching users with the same profile fields as user.get, including avatar, join date, post and comment counts and the admin flag.
    - _items:_
      - **id** (required) — type `integer`. User id on this instance.
      - **name** (required) — type `string`. Username without the host.
      - **displayName** (required) — type `string`; nullable. Display name.
      - **bio** (required) — type `string`; nullable. Profile text as Markdown.
      - **avatar** (required) — type `string`; nullable. Avatar URL.
      - **banner** (required) — type `string`; nullable. Banner URL.
      - **actorId** (required) — type `string`; nullable. Canonical ActivityPub id.
      - **host** (required) — type `string`; nullable. Host the account lives on.
      - **handle** (required) — type `string`; nullable. `user@host`.
      - **publishedAt** (required) — type `string`; nullable. When the account was created.
      - **updatedAt** (required) — type `string`; nullable. When the profile last changed.
      - **banned** (required) — type `boolean`; nullable. Whether the account is banned.
      - **banExpiresAt** (required) — type `string`; nullable. When the ban ends.
      - **deleted** (required) — type `boolean`; nullable. Whether the account was deleted.
      - **isBot** (required) — type `boolean`; nullable. Whether the account is a bot.
      - **isLocal** (required) — type `boolean`; nullable. Whether the account lives on the instance asked.
      - **matrixUserId** (required) — type `string`; nullable. Matrix id the user chose to publish.
      - **postCount** (required) — type `integer`; nullable. Posts the user has made.
      - **commentCount** (required) — type `integer`; nullable. Comments the user has made.
      - **postScore** (required) — type `integer`; nullable. Combined score of the user's posts, when the instance reports it.
      - **commentScore** (required) — type `integer`; nullable. Combined score of the user's comments, when the instance reports it.
      - **isAdmin** (required) — type `boolean`; nullable. Whether the user is an instance administrator.
      - **moderates** (required) — type `array`; nullable. Communities the user moderates; null when the answer did not carry them.
        - _items:_
  - **page** (required) — type `object`. Pagination state for the current page.
    - **page** (required) — type `integer`; minimum: 0. Current page number. Lemmy pages by number over a live order, so new or re-ranked items can shift a row onto the next page. Remove repeats by `id`.
    - **hasMore** (required) — type `boolean`. Whether a full page came back, so another page may exist. A last page that exactly fills the limit still sets true, and the next page is then empty.
    - **nextPage** (required) — type `integer`; minimum: 0; nullable. Next page number; null when this page was short, so the list ended.
    - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request; null when this page was short. It only works with the same filters.
    - **limitReached** (required) — type `boolean`. True when a full page stopped at the instance's 100-page ceiling and rows may remain. False when the list ended because it ran out.
- **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,
    "type": "Posts",
    "posts": [
      {
        "id": 54092132,
        "apId": "https://infosec.pub/post/54608928",
        "title": "Reproduction and Detections CVE-2026-98432 — Reproducing the Linux `ip_options_rcu` Use-After-Free - \"What it does not require: MPTCP (a plain TCP listener is vulnerable\"",
        "url": "https://gist.github.com/Blevene/588d00d517bc18b78f61427d606100a9",
        "urlContentType": "text/html; charset=utf-8",
        "thumbnailUrl": "https://lemmy.world/pictrs/image/6eab6a05-15b2-4346-8ce9-4cfb67882b5e.png",
        "nsfw": false,
        "locked": false,
        "removed": false,
        "deleted": false,
        "publishedAt": "2026-11-07T06:57:36.739Z",
        "updatedAt": null,
        "languageId": 37,
        "isLocal": false,
        "score": 1,
        "upvotes": 1,
        "downvotes": 0,
        "commentCount": 0,
        "community": {
          "id": 20875,
          "name": "blueteamsec",
          "title": "blueteamsec",
          "actorId": "https://infosec.pub/c/blueteamsec",
          "host": "infosec.pub",
          "handle": "blueteamsec@infosec.pub",
          "icon": "https://infosec.pub/pictrs/image/4b521595-5cff-49aa-afc9-1a2e28273947.png",
          "nsfw": false,
          "isLocal": false,
          "description": "For [Blue|Purple] Teams in Cyber Defence - covering discovery, detection, response, threat intelligence, malware, offensive tradecraft and tooling, deception,  reverse engineering etc.",
          "banner": "https://infosec.pub/pictrs/image/98ea0881-600c-424f-8e06-e82e196517dc.png",
          "publishedAt": "2023-06-18T15:54:36.372Z",
          "updatedAt": "2025-07-31T18:24:24.153Z",
          "removed": false,
          "deleted": false,
          "hidden": false,
          "postingRestrictedToMods": false,
          "visibility": "Public",
          "subscriberCount": null,
          "localSubscriberCount": null,
          "postCount": null,
          "commentCount": null,
          "activeUsers": null,
          "moderators": null,
          "languageIds": null
        },
        "author": {
          "id": 244464,
          "name": "digicat",
          "displayName": "digicat",
          "bio": "digital purrr... and Reddit refugee ...",
          "avatar": "https://infosec.pub/pictrs/image/b17baf83-22a3-43be-82b6-22c3c695b230.jpeg",
          "banner": null,
          "actorId": "https://infosec.pub/u/digicat",
          "host": "infosec.pub",
          "handle": "digicat@infosec.pub",
          "publishedAt": "2023-06-18T15:52:36.836Z",
          "updatedAt": null,
          "banned": false,
          "banExpiresAt": null,
          "deleted": false,
          "isBot": false,
          "isLocal": false,
          "matrixUserId": null
        },
        "body": null,
        "embed": {
          "title": "Reproduction and Detections CVE-2026-98432 — Reproducing the Linux `ip_options_rcu` Use-After-Free",
          "description": "Reproduction and Detections CVE-2026-98432 — Reproducing the Linux `ip_options_rcu` Use-After-Free - CVE-2026-98432_reproduction_report.md",
          "videoUrl": null
        },
        "altText": null,
        "image": {
          "link": "https://lemmy.world/pictrs/image/6eab6a05-15b2-4346-8ce9-4cfb67882b5e.png",
          "width": 512,
          "height": 256,
          "contentType": "image/png"
        },
        "featuredInCommunity": false,
        "featuredOnInstance": false,
        "newestCommentAt": "2026-11-07T06:57:36.739Z",
        "isAdmin": false,
        "isModerator": true,
        "bannedFromCommunity": false,
        "crossPosts": null,
        "moderators": null
      }
    ],
    "comments": [],
    "communities": [],
    "users": [],
    "page": {
      "page": 1,
      "hasMore": true,
      "nextPage": 2,
      "nextCursor": "eyJwIjoyLCJmIjoiW1tcImluc3RhbmNlXCIsXCJsZW1teS53b3JsZFwiXSxbXCJxdWVyeVwiLFwibGludXhcIl0sW1widHlwZVwiLFwiUG9zdHNcIl0sW1wic29ydFwiLG51bGxdLFtcImNvbW11bml0eVwiLG51bGxdLFtcImF1dGhvclwiLG51bGxdLFtcInNjb3BlXCIsbnVsbF0sW1wibGltaXRcIiwyXV0ifQ",
      "limitReached": false
    }
  },
  "meta": {
    "requestId": "req_4f7dfd27-d552-4e47-9738-0687f7636127",
    "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.search({
  instance: "lemmy.world",
  query: "linux",
});

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

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

### cURL

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

### Python

```python
import requests

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

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/lemmy/search");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```