Get Mastodon server
Get a Mastodon server's public profile, rules and statistics.
Headers
Get your API keyAPI key (`sfk_...`)
The Mastodon server to ask, e.g. `mastodon.social`. A server URL is also accepted. The server you name is the one that answers.
Comma-separated extras: `rules` (the server's rules) and `about` (its long description).
any of: rules, about (comma-separated)
Endpoint-specific response payload.
`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`.
one of: found, not_found, restricted, unsupported, not_compatible
The server that was asked.
Server software when known (`mastodon`, `pleroma`, `akkoma`, `hometown`, `kmyblue`, ...), else null.
Why `lookupStatus` is not `found`, or null when it is `found`.
Machine-readable reason.
one of: 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
Plain-language explanation.
The server's profile when `lookupStatus` is `found`; otherwise null.
The server's public name.
Short description of the server.
The server's own version string.
Version of the software behind the server, when known.
Source code page for the server software.
Languages the server lists, as ISO codes.
Server thumbnail, when it has one.
Server thumbnail image.
Blurhash placeholder for the thumbnail.
Icons the server publishes.
Icon file.
Icon size, such as `192x192`.
How registration works on this server.
True when anyone may register.
True when an operator must approve new registrations.
True when a reason is required to register.
Minimum age to register, in years.
Registration message as sanitised HTML.
The operator's public contact account. The contact email is never returned.
Account id on `host`.
The server this record came from.
`user@host`, with the account's home server.
Username without the host.
Profile page.
ActivityPub id, when the server shows it.
Display name.
Bio as sanitised HTML.
Bio as plain text.
An avatar or header image.
Image URL on the server or its media store.
Still frame of an animated image.
Alt text.
An avatar or header image.
Image URL on the server or its media store.
Still frame of an animated image.
Alt text.
Account creation, rounded to midnight UTC by the server.
Date of the latest post (a date, not a time).
The server's own counters.
Accounts following this account.
Accounts this account follows.
Posts by this account.
True when the account is marked as a bot.
True when the account is a group.
Follow requests need approval. Public posts are still public.
The server's moderators limited (silenced) the account.
True when the server suspended the account.
The owner's opt-in to the profile directory and recommendations. null on servers that do not report it.
The owner's opt-in to search engines indexing public posts. null when not reported.
The owner asks search engines to skip the profile. null when not reported.
The owner hides the follower and following lists. null when not reported.
The account this one moved to.
Account id on the server that returned it.
`user@host` of the account this one moved to.
Profile page of the new account.
Display name of the new account.
Profile metadata fields, in the owner's order.
Label.
Value as sanitised HTML.
Value as plain text.
When a link in the value was verified with rel=me.
Custom emojis used in the display name or bio.
Shortcode without colons.
Emoji image.
Still frame.
Public badges such as Owner or Moderator.
Role id on `host`.
Role name, such as Owner or Moderator.
Badge colour as a hex value, when set.
Posting limits the server reports.
Maximum characters in a post.
Maximum media attachments in one post.
Maximum options in a poll.
Maximum image size, in bytes.
Maximum video size, in bytes.
Maximum featured hashtags per account.
The server's own counters.
Accounts on the server.
Posts on the server.
Servers this one has seen.
Accounts active in the last month.
Pages the operator links from the server.
The server's about page.
The server's privacy policy.
The server's terms of service.
The server's status page.
The server's donation page.
Features the server reports.
True when the server offers post translation.
True when the server offers public search.
True when the server limits federation.
Who may read the public timelines without a login. Null on servers older than Mastodon 4.5.
Access to the live public timeline.
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
Access to hashtag timelines.
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
Access to trending link lists.
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
`public` anyone, `authenticated` login required, `disabled` switched off.
one of: public, authenticated, disabled
Rules when `include=rules`, else null.
Rule id on `host`.
Rule text.
Extra guidance for the rule.
Long description when `include=about`, else null.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
min 1 chars
Credits charged for this request.
≥ 0
Public API version that served the response.
one of: v1
Code example
curl "https://api.socialfetch.dev/v1/mastodon/servers/mastodon.social?include=rules" \
-H "x-api-key: YOUR_API_KEY"Responses
The server's public profile.