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

## Summary

Get a Mastodon server's public profile, rules and statistics.

**Tags:** `Mastodon`

## HTTP

- **Method:** GET
- **Path:** `/v1/mastodon/servers/{host}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.mastodon.getServer({ host: "mastodon.social", include: ["rules"] })`
- **Accepted identifiers:** `host` (path)
- **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` (path)

- **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.

### `include` (query)

- **Required:** no
- **Constraints:** type `array`
- **Description:** Comma-separated extras: `rules` (the server's rules) and `about` (its long description).

## Responses (status codes)

- **200**: The server's public profile.
- **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)

The server's public profile.

### 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** (required) — type `string`; nullable. Server software when known (`mastodon`, `pleroma`, `akkoma`, `hometown`, `kmyblue`, ...), else null.
  - **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.
  - **server** (required) — type `object`; nullable. The server's profile when `lookupStatus` is `found`; otherwise null.
    - **title** (required) — type `string`; nullable. The server's public name.
    - **description** (required) — type `string`; nullable. Short description of the server.
    - **version** (required) — type `string`; nullable. The server's own version string.
    - **softwareVersion** (required) — type `string`; nullable. Version of the software behind the server, when known.
    - **sourceUrl** (required) — type `string`; nullable. Source code page for the server software.
    - **languages** (required) — type `array`. Languages the server lists, as ISO codes.
      - _items:_
        - type `string`
    - **thumbnail** (required) — type `object`; nullable. Server thumbnail, when it has one.
      - **url** (required) — type `string`; nullable. Server thumbnail image.
      - **blurhash** (required) — type `string`; nullable. Blurhash placeholder for the thumbnail.
    - **icons** (required) — type `array`. Icons the server publishes.
      - _items:_
    - **registrations** (required) — type `object`. How registration works on this server.
      - **open** (required) — type `boolean`; nullable. True when anyone may register.
      - **approvalRequired** (required) — type `boolean`; nullable. True when an operator must approve new registrations.
      - **reasonRequired** (required) — type `boolean`; nullable. True when a reason is required to register.
      - **minAge** (required) — type `integer`; nullable. Minimum age to register, in years.
      - **messageHtml** (required) — type `string`; nullable. Registration message as sanitised HTML.
    - **contactAccount** (required) — type `object`; nullable. The operator's public contact account. The contact email is never returned.
      - **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:_
    - **limits** (required) — type `object`. Posting limits the server reports.
      - **postCharacters** (required) — type `integer`; nullable. Maximum characters in a post.
      - **mediaPerPost** (required) — type `integer`; nullable. Maximum media attachments in one post.
      - **pollOptions** (required) — type `integer`; nullable. Maximum options in a poll.
      - **imageBytes** (required) — type `integer`; nullable. Maximum image size, in bytes.
      - **videoBytes** (required) — type `integer`; nullable. Maximum video size, in bytes.
      - **featuredTags** (required) — type `integer`; nullable. Maximum featured hashtags per account.
    - **stats** (required) — type `object`. The server's own counters.
      - **users** (required) — type `integer`; nullable. Accounts on the server.
      - **posts** (required) — type `integer`; nullable. Posts on the server.
      - **knownDomains** (required) — type `integer`; nullable. Servers this one has seen.
      - **activeUsersMonth** (required) — type `integer`; nullable. Accounts active in the last month.
    - **links** (required) — type `object`. Pages the operator links from the server.
      - **about** (required) — type `string`; nullable. The server's about page.
      - **privacyPolicy** (required) — type `string`; nullable. The server's privacy policy.
      - **termsOfService** (required) — type `string`; nullable. The server's terms of service.
      - **status** (required) — type `string`; nullable. The server's status page.
      - **donation** (required) — type `string`; nullable. The server's donation page.
    - **features** (required) — type `object`. Features the server reports.
      - **translation** (required) — type `boolean`; nullable. True when the server offers post translation.
      - **search** (required) — type `boolean`; nullable. True when the server offers public search.
      - **limitedFederation** (required) — type `boolean`; nullable. True when the server limits federation.
    - **access** (required) — type `object`; nullable. Who may read the public timelines without a login. Null on servers older than Mastodon 4.5.
      - **liveFeeds** (required) — type `object`. Access to the live public timeline.
      - **hashtagFeeds** (required) — type `object`. Access to hashtag timelines.
      - **trendingLinkFeeds** (required) — type `object`. Access to trending link lists.
    - **rules** (required) — type `array`; nullable. Rules when `include=rules`, else null.
      - _items:_
    - **aboutHtml** (required) — type `string`; nullable. Long description when `include=about`, else null.
- **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",
    "software": "mastodon",
    "reason": null,
    "server": {
      "title": "Mastodon.social",
      "description": "The original server of Mastodon, operated by Mastodon GmbH for the common good.",
      "version": "5.0.0-nightly.2026-11-05",
      "softwareVersion": "5.0.0-nightly.2026-11-05",
      "sourceUrl": "https://github.com/mastodon/mastodon",
      "languages": [
        "en"
      ],
      "thumbnail": {
        "url": "https://files.mastodon.social/site_uploads/files/000/000/001/@1x/57c12f441d083cde.png",
        "blurhash": "UeKUpFxuo~R%0nW;WCnhF6RjaJt757oJodS$"
      },
      "icons": [
        {
          "src": "https://mastodon.social/packs/assets/android-chrome-36x36-DLiBQg3N.png",
          "size": "36x36"
        }
      ],
      "registrations": {
        "open": true,
        "approvalRequired": false,
        "reasonRequired": false,
        "minAge": 16,
        "messageHtml": null
      },
      "contactAccount": {
        "id": "13179",
        "host": "mastodon.social",
        "handle": "Mastodon@mastodon.social",
        "username": "Mastodon",
        "url": "https://mastodon.social/@Mastodon",
        "actorUri": "https://mastodon.social/users/Mastodon",
        "displayName": "Mastodon",
        "bioHtml": "<p>Our mission is to connect the world through thriving online communities.</p><p>This is the primary account for the Mastodon project.</p><p>For technical software updates, follow <span class=\"h-card\" translate=\"no\"><a href=\"https://mastodon.social/@MastodonEngineering\" class=\"u-url mention\">@<span>MastodonEngineerin…",
        "bio": "Our mission is to connect the world through thriving online communities.\n\nThis is the primary account for the Mastodon project.\n\nFor technical software updates, follow @MastodonEngineering\n\nFor news and updates on the Mastodon servers that we operate (like this one!), follow @staff",
        "avatar": {
          "url": "https://files.mastodon.social/accounts/avatars/000/013/179/original/b4ceb19c9c54ec7e.png",
          "staticUrl": "https://files.mastodon.social/accounts/avatars/000/013/179/original/b4ceb19c9c54ec7e.png",
          "description": "The Mastodon logo: a white shape of a stylised elephant head; a bold lower-case m shape is cut out, showing a soothing purple gradient."
        },
        "header": {
          "url": "https://files.mastodon.social/accounts/headers/000/013/179/original/1375be116fbe0f1d.png",
          "staticUrl": "https://files.mastodon.social/accounts/headers/000/013/179/original/1375be116fbe0f1d.png",
          "description": "An image of a mobile device displaying the Mastodon app, on a cartoon background featuring rolling hills and white fluffy clouds."
        },
        "createdAt": "2016-11-23T00:00:00.000Z",
        "lastPostDate": "2026-10-19",
        "stats": {
          "followers": 878668,
          "following": 51,
          "posts": 567
        },
        "isBot": false,
        "isGroup": false,
        "isLocked": false,
        "isLimited": false,
        "isSuspended": false,
        "isDiscoverable": true,
        "isIndexable": true,
        "noIndex": false,
        "hidesNetwork": false,
        "movedTo": null,
        "fields": [
          {
            "name": "Homepage",
            "valueHtml": "<a href=\"https://joinmastodon.org\" target=\"_blank\" rel=\"nofollow noopener me\" translate=\"no\"><span class=\"invisible\">https://</span><span class=\"\">joinmastodon.org</span><span class=\"invisible\"></span></a>",
            "value": "https://joinmastodon.org",
            "verifiedAt": "2018-10-31T04:11:00.076+00:00"
          }
        ],
        "emojis": [],
        "roles": []
      },
      "limits": {
        "postCharacters": 500,
        "mediaPerPost": 4,
        "pollOptions": 4,
        "imageBytes": 16777216,
        "videoBytes": 103809024,
        "featuredTags": 10
      },
      "stats": {
        "users": 3466310,
        "posts": 194631034,
        "knownDomains": 126445,
        "activeUsersMonth": 271011
      },
      "links": {
        "about": "https://mastodon.social/about",
        "privacyPolicy": "https://mastodon.social/privacy-policy",
        "termsOfService": "https://mastodon.social/terms-of-service",
        "status": "https://status.mastodon.social/",
        "donation": null
      },
      "features": {
        "translation": true,
        "search": null,
        "limitedFederation": false
      },
      "access": {
        "liveFeeds": {
          "local": "disabled",
          "remote": "disabled"
        },
        "hashtagFeeds": {
          "local": "public",
          "remote": "public"
        },
        "trendingLinkFeeds": {
          "local": "public",
          "remote": "public"
        }
      },
      "rules": null,
      "aboutHtml": null
    }
  },
  "meta": {
    "requestId": "req_9843dee1-0b76-4e38-96ef-a0940aec345e",
    "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.getServer({
  host: "mastodon.social",
  include: ["rules"],
});

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/servers/mastodon.social?include=rules",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

### cURL

```bash
curl "https://api.socialfetch.dev/v1/mastodon/servers/mastodon.social?include=rules" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/mastodon/servers/mastodon.social?include=rules",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```