Mastodon

List Mastodon server peers

List the domains a Mastodon server federates with.

GET/v1/mastodon/servers/{host}/peers
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
4
hoststringrequiredpath

The Mastodon server to ask, e.g. `mastodon.social`. A server URL is also accepted. The server you name is the one that answers.

qstringoptionalquery

Only domains containing this text.

min 1 chars · max 100 chars

cursorstringoptionalquery

Pass `page.nextCursor` from the previous response to get the next page.

min 1 chars · max 512 chars

limitintegeroptionalquery

Items per page, 1 to 1000. Default: 100.

≥ 1 · ≤ 1000

Response fields
18

Endpoint-specific response payload.

datalookupStatus
string

`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

datahost
string

The server that was asked.

datasoftware
stringnullableoptional

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.

Why `lookupStatus` is not `found`, or null when it is `found`.

datareasoncode
string

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

datareasonmessage
string

Plain-language explanation.

dataquery
stringnullable

The text `q` filtered by, or null when it was omitted.

datatotalPeers
integernullable

Domains matching `q` (or all domains) across every page.

Domains the server has seen. Includes dead domains and servers running other software.

datapeers[]
stringoptional

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor to pass in the next request when more pages exist; null on the last page.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/mastodon/servers/mastodon.social/peers" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Domains the server has seen.