InsightSocial
GET /v1/mastodon/directorybeta

Mastodon Directory API

List the accounts a Mastodon server shows in its directory.

20 credits a call · cursor pagination · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/mastodon/directory?host=<host>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "mastodon",
"endpoint": "/v1/mastodon/directory",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"pagination": {
"next_cursor": "<string | null>",
"has_more": "<boolean>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/mastodon/directory. Send your key in the x-api-key header.

NameRequiredDescription
hostYesThe Mastodon server to ask, e.g. mastodon.social. A server URL is also accepted. The server you name is the one that answers.
orderNoactive (default) most recently active first, new newest first.
scopeNoall (default) or local for the server's own accounts only.
offsetNoItems to skip, as an offset. Prefer cursor for the next page. Default: 0.
limitNoItems per page, 1 to 80. Default: 40.
cursorNoPass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Mastodon Directory API reference.

How much does the Mastodon Directory API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Mastodon Directory API: frequently asked questions

Send GET /v1/mastodon/directory with the host parameter and your key in the x-api-key header. List the accounts a Mastodon server shows in its directory.