Mastodon Directory API reference
Your first 10 calls are free, no card needed. Pricing and FAQ
Get a free API keycurl "https://api.insightsocial.app/v1/mastodon/directory?host=<host>" \ -H "x-api-key: $INSIGHTSOCIAL_API_KEY"
List the accounts a Mastodon server shows in its directory.
Beta. The source's own structure under our naming rules (snake_case keys, string ids, ISO times where the source gives a timestamp), not one of the schema-2 entities. Fields may change. See Beta endpoints.
20 credits per call.
Paginates by cursor: see Pagination.
Authorization
apiKey Your key from the dashboard. It starts with isk_.
In: header
Query Parameters
The Mastodon server to ask, e.g. mastodon.social. A server URL is also accepted. The server you name is the one that answers.
active (default) most recently active first, new newest first.
Value in
- "active"
- "new"
all (default) or local for the server's own accounts only.
Value in
- "all"
- "local"
Items to skip, as an offset. Prefer cursor for the next page. Default: 0.
0 <= value <= 100000Items per page, 1 to 80. Default: 40.
1 <= value <= 80Pass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.
Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.
Value in
- "1"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.insightsocial.app/v1/mastodon/directory?host=string"{ "success": true, "platform": "string", "endpoint": "string", "schema_version": "2", "pagination": { "next_cursor": "string", "has_more": true, "page_size": 0, "stopped_at": "since" }, "unavailable": [ "string" ], "credits_used": 0, "credits_remaining": 0, "request_id": "string", "cached": true, "idempotent_replay": true, "charge_reason": "string", "free_call": true, "data": { "property1": null, "property2": null }}