Instances
GET {{baseUrl}}/api/1.0/instances/list?count=100&min_users=20000
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
count | number | Number of instances to get. 0 returns all instances. | |
include_dead | null | Include dead (down for at least two weeks) instances | |
include_down | null | Include down instances | |
include_closed | null | Include instances with closed registrations | |
supported_features | null | Comma-separated list of features returned instances have to support | |
min_version | null | Minimal Mastodon version returned instances must be running. Format must be "a.b.c" (".b" and ".c" can be omitted) with a, b, c being integers. | |
min_users | number | Minimal users returned instances must have. | |
max_users | null | Maximal users returned instances must have. | |
min_active_users | null | Minimal active users per week returned instances must have. This will filter out instances running Mastodon versions older than 2.1.2. | |
category | null | Category instances must be in to be returned. Value general will return instances in no category. | |
language | null | Language instances must have as main language to be returned. | |
prohibited_content | null | Content returned instances must prohibita. | |
allowed_content | null | Content returned instances must not prohibit. | |
min_id | null | Minimal ID of instances to retrieve. Use this to navigate through pages. The id of the first instance from next page is accessible through pagination.next_id. | |
sort_by | null | Field to sort instances by. By default, instances are not sorted and their order is not guaranteed to be consistent. | |
sort_order | null | Sort order, if sort_by is used. |