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

## Summary

Search a Mastodon server for accounts, hashtags or posts.

**Tags:** `Mastodon`

## HTTP

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

## Capability summary

- **SDK mapping:** `client.mastodon.search({ host: "mastodon.social", query: "photography" })`
- **Accepted identifiers:** `query` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `restricted`, `unsupported`, `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

### `host` (query)

- **Required:** yes
- **Constraints:** type `string`
- **Description:** The Mastodon server to ask, e.g. `mastodon.social`. A server URL is also accepted. The server you name is the one that answers.

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 300
- **Description:** Search text.

### `type` (query)

- **Required:** no
- **Constraints:** type `string`; enum: accounts, hashtags, posts
- **Description:** What to search. Omit for accounts and hashtags. `posts` works only on servers whose software allows searching posts without a login (Pleroma, Akkoma and some others); Mastodon itself does not.

### `limit` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 40
- **Description:** Items per page, 1 to 40. Default: 20.

## Responses (status codes)

- **200**: Accounts, hashtags or posts matching the query.
- **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)

Accounts, hashtags or posts matching the query.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted, unsupported, not_compatible. `found`, `not_found`, `restricted` (login required or closed), `unsupported` (this server does not offer it) or `not_compatible` (the host is not a Mastodon-compatible server). See `reason`.
  - **host** (required) — type `string`. The server that was asked.
  - **software** (optional) — type `string`; nullable. Only on a `not_compatible` result (and always on the server endpoint): the software the host runs, from its NodeInfo, e.g. `misskey` or `lemmy`; null when it does not say. Absent otherwise.
  - **reason** (required) — type `object`; nullable. Why `lookupStatus` is not `found`, or null when it is `found`.
    - **code** (required) — type `string`; enum: login_required, closed_by_operator, hidden_by_owner, suspended, not_implemented, disabled_by_operator, not_a_mastodon_server, unsupported_server_software, host_not_found, post_not_visible. Machine-readable reason.
    - **message** (required) — type `string`. Plain-language explanation.
  - **query** (required) — type `string`. The search text that was asked for.
  - **type** (required) — type `string`; enum: accounts, hashtags, posts, null; nullable. The type that was asked for, or null when it was omitted.
  - **accounts** (required) — type `array`. Matching accounts, in the server's order.
    - _items:_
      - **id** (required) — type `string`. Account id on `host`.
      - **host** (required) — type `string`. The server this record came from.
      - **handle** (required) — type `string`. `user@host`, with the account's home server.
      - **username** (required) — type `string`. Username without the host.
      - **url** (required) — type `string`; nullable. Profile page.
      - **actorUri** (required) — type `string`; nullable. ActivityPub id, when the server shows it.
      - **displayName** (required) — type `string`; nullable. Display name.
      - **bioHtml** (required) — type `string`; nullable. Bio as sanitised HTML.
      - **bio** (required) — type `string`; nullable. Bio as plain text.
      - **avatar** (required) — type `object`. An avatar or header image.
      - **header** (required) — type `object`. An avatar or header image.
      - **createdAt** (required) — type `string`; nullable. Account creation, rounded to midnight UTC by the server.
      - **lastPostDate** (required) — type `string`; nullable. Date of the latest post (a date, not a time).
      - **stats** (required) — type `object`. The server's own counters.
      - **isBot** (required) — type `boolean`. True when the account is marked as a bot.
      - **isGroup** (required) — type `boolean`. True when the account is a group.
      - **isLocked** (required) — type `boolean`. Follow requests need approval. Public posts are still public.
      - **isLimited** (required) — type `boolean`. The server's moderators limited (silenced) the account.
      - **isSuspended** (required) — type `boolean`. True when the server suspended the account.
      - **isDiscoverable** (required) — type `boolean`; nullable. The owner's opt-in to the profile directory and recommendations. null on servers that do not report it.
      - **isIndexable** (required) — type `boolean`; nullable. The owner's opt-in to search engines indexing public posts. null when not reported.
      - **noIndex** (required) — type `boolean`; nullable. The owner asks search engines to skip the profile. null when not reported.
      - **hidesNetwork** (required) — type `boolean`; nullable. The owner hides the follower and following lists. null when not reported.
      - **movedTo** (required) — type `object`; nullable. The account this one moved to.
      - **fields** (required) — type `array`. Profile metadata fields, in the owner's order.
        - _items:_
      - **emojis** (required) — type `array`. Custom emojis used in the display name or bio.
        - _items:_
      - **roles** (required) — type `array`. Public badges such as Owner or Moderator.
        - _items:_
  - **hashtags** (required) — type `array`. Matching hashtags, in the server's order.
    - _items:_
      - **name** (required) — type `string`. Hashtag name without the `#`.
      - **url** (required) — type `string`; nullable. Hashtag page on the server.
      - **history** (required) — type `array`. Daily uses and distinct accounts, newest first.
        - _items:_
  - **posts** (required) — type `array`. Matching posts, in the server's order.
    - _items:_
      - **id** (required) — type `string`. Post id on `host`.
      - **host** (required) — type `string`. The server this record came from.
      - **url** (required) — type `string`; nullable. Post page.
      - **uri** (required) — type `string`; nullable. ActivityPub id. Stable across servers.
      - **createdAt** (required) — type `string`; nullable. ISO-8601 UTC.
      - **editedAt** (required) — type `string`; nullable. When the post was last edited, or null.
      - **language** (required) — type `string`; nullable. ISO code, or null when unset.
      - **contentHtml** (required) — type `string`; nullable. Post body as sanitised HTML.
      - **text** (required) — type `string`; nullable. Post body as plain text.
      - **contentWarning** (required) — type `string`; nullable. Content warning text.
      - **isSensitive** (required) — type `boolean`. True when the author marked the post sensitive.
      - **visibility** (required) — type `string`; nullable. `public` or `unlisted`.
      - **author** (required) — type `object`. The account that wrote the post.
      - **replyTo** (required) — type `object`; nullable. The post this replies to. Ids belong to `host`.
      - **stats** (required) — type `object`. Engagement counters as the server reports them.
      - **media** (required) — type `array`. Media attached to the post.
        - _items:_
      - **hashtags** (required) — type `array`. Hashtags in the post.
        - _items:_
      - **mentions** (required) — type `array`. Accounts mentioned in the post.
        - _items:_
      - **emojis** (required) — type `array`. Custom emojis used in the post.
        - _items:_
      - **card** (required) — type `object`; nullable. Link preview card, when the post has one.
      - **poll** (required) — type `object`; nullable. Poll, when the post has one.
      - **app** (required) — type `object`; nullable. The client the author posted from.
      - **isBoost** (required) — type `boolean`. True when this is a boost of another post.
      - **boostOf** (required) — type `object`; nullable. The boosted post when `isBoost` is true.
      - **quote** (required) — type `object`; nullable. The quoted post, on servers that support quotes.
- **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",
    "host": "mastodon.social",
    "reason": null,
    "query": "photography",
    "type": null,
    "accounts": [
      {
        "id": "110550726066905822",
        "host": "mastodon.social",
        "handle": "photography@lemmy.world",
        "username": "photography",
        "url": "https://lemmy.world/c/photography",
        "actorUri": "https://lemmy.world/c/photography",
        "displayName": "Photography",
        "bioHtml": "<p>A community to post about photography:</p>\n<p>We allow a wide range of topics here including; your own images, technical questions, gear talk, photography blogs etc. Please be respectful and don’t spam.</p>",
        "bio": "A community to post about photography:\n\nWe allow a wide range of topics here including; your own images, technical questions, gear talk, photography blogs etc. Please be respectful and don’t spam.",
        "avatar": {
          "url": "https://mastodon.social/avatars/original/missing.png",
          "staticUrl": "https://mastodon.social/avatars/original/missing.png",
          "description": null
        },
        "header": {
          "url": "https://mastodon.social/headers/original/missing.png",
          "staticUrl": "https://mastodon.social/headers/original/missing.png",
          "description": null
        },
        "createdAt": "2023-06-09T00:00:00.000Z",
        "lastPostDate": "2026-11-07",
        "stats": {
          "followers": 8129,
          "following": 0,
          "posts": 384
        },
        "isBot": false,
        "isGroup": true,
        "isLocked": false,
        "isLimited": false,
        "isSuspended": false,
        "isDiscoverable": false,
        "isIndexable": false,
        "noIndex": null,
        "hidesNetwork": true,
        "movedTo": null,
        "fields": [],
        "emojis": [],
        "roles": []
      }
    ],
    "hashtags": [
      {
        "name": "photography",
        "url": "https://mastodon.social/tags/photography",
        "history": [
          {
            "date": "2026-11-07",
            "uses": 101,
            "accounts": 67
          }
        ]
      }
    ],
    "posts": []
  },
  "meta": {
    "requestId": "req_1fa7fa04-ba49-4fad-9e7b-6ceb01264e37",
    "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.mastodon.search({
  host: "mastodon.social",
  query: "photography",
});

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/mastodon/search?host=mastodon.social&query=photography",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

### cURL

```bash
curl "https://api.socialfetch.dev/v1/mastodon/search?host=mastodon.social&query=photography" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/mastodon/search?host=mastodon.social&query=photography",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```