GET

/api/v1/instances

Misskeyサーバーの一覧を取得します。検索、ソート、ページネーションに対応しています。

Query Parameters

Parameter	Type	Default	Description
sort	string	"users"	ソート項目`users`, `notes`, `createdAt`, `recommended`, `repository` のいずれか
language	string	なし	言語コード (ISO 639-1)。自動検出のため、実際の主要言語と異なる場合があります
order	string	"desc"	ソート順`asc` または `desc`
limit	number	30	取得件数 (1以上100以下)
offset	number	0	ページネーションのオフセット (0以上)
search	string	-	サーバー名で検索 (部分一致)
repository	string	-	リポジトリURL (完全一致)`official` は本家リポジトリを指します
open_registrations	boolean	-	登録開放状況`true` または `false`
email_required	boolean	-	メールアドレス必須かどうか`true` または `false`
min_users	number	-	最小ユーザー数 (0以上)
max_users	number	-	最大ユーザー数 (0以上)

許容値の範囲外や型の異なる値を渡した場合は 400 Bad Request を返します。同じパラメータを複数回指定した場合も同様です。

Response

{
  "items": [
    {
      "host": "example.com",
      "name": "Example Instance",
      "users_count": 100,
      "notes_count": 10000,
      "created_at": 1704067200000,
      "version": "2024.1.0",
      "is_alive": true,
      "last_updated": 1704153600000,
      "last_check_at": 1704153600000,
      "banner_url": "https://example.com/banner.jpg",
      "icon_url": "https://example.com/icon.png",
      "language": "ja"
    }
  ],
  "total": 500,
  "limit": 30,
  "offset": 0
}

Example

cURL

curl "https://servers.misskey.ink/api/v1/instances?sort=users&order=desc&limit=10"