Mastodon server info

docs menu

GET https://api.api.sh/mastodon/v1/instance

1 credit / call social try it in the playground →

A server's details: title, software version, description, languages, monthly active users, thumbnail and icon, registration status, contact account, server rules and posting limits.

Every response includes credits_used: the credits this call cost.

Parameters

name	type	description
`instance`	string	Server host name (default mastodon.social). Example: `mastodon.social`

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/mastodon/v1/instance?instance=mastodon.social" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/mastodon/v1/instance",
    params={"instance": "mastodon.social"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/mastodon/v1/instance");
url.searchParams.set("instance", "mastodon.social");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Response

A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).

The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.