ランキング
警告
本APIは将来的に廃止(破壊的な仕様変更)を予定しています。
移行期間や廃止日が決定次第、サポートサーバーおよびTwitterアカウントにてお知らせいたします。
各種ランキング(整地量・建築量・投票数・接続時間の総合・日間・週間・月間・年間ランキング)を取得できます。
使用例はこちら -> https://seichi.conarin.com/ranking
エンドポイント
GET /seichi/ranking
クエリパラメータ
| 名前 | 型 | 内容 | 初期値 |
|---|---|---|---|
| duration | string | ランキングの期間total、daily、weekly、monthly、yearlyのいずれかを指定 | total |
| type | string | ランキングの種類break_count、build_count、play_ticks、vote_countのいずれかを指定 | break_count |
| offset | number | 1位から何位離れているか 0以上の整数を指定 | 0 |
| limit | number | 結果の上限 1以上100以下の整数を指定 | 20 |
| date | string | データの年月日YYYY-MM-DD形式で指定 | JSTでの現在の日付 |
例
GET /seichi/ranking?duration=total&type=break_count&offset=0&limit=1&date=2023-07-05
レスポンス
成功時
| 名前 | 型 | 内容 |
|---|---|---|
| ranks | array | 順位の昇順(1, 2, 3...)でソートされたプレイヤーデータの配列 |
| ranks[x] | object | プレイヤーデータの構造を参照 |
| resultCount | number | ranksの件数 |
| totalCount | number | ランキングの総数 |
| updatedAt | string | ランキングデータの更新日時 形式は YYYY-MM-DDThh:mm:ss+09:00 |
| params | object | 実際に解釈されたパラメータ パラメータ名、型、値の候補や範囲はクエリパラメータと同一 |
{
"ranks": [
{
"player": {
"uuid": "6d705d18-296a-47d9-b5cf-1b557c7a35e7",
"name": "Ys12"
},
"levels": {
"seichi": {
"level": 200,
"starLevel": 269
},
"build": {
"level": 15
}
},
"ranks": [
{
"duration": "total",
"type": "break_count",
"value": "23435689052",
"rank": 1
}
],
"lastLoginAt": "1970-01-01T09:00:00+09:00"
}
],
"resultsCount": 1,
"totalCount": 34067,
"updatedAt": "2023-07-05T23:59:33+09:00",
"params": {
"duration": "total",
"type": "break_count",
"offset": 0,
"limit": 1,
"date": "2023-07-05"
}
}
例外時
| 名前 | 型 | 内容 |
|---|---|---|
| error | object | エラー情報が格納されたオブジェクト |
| error.code | number | HTTPステータスコード404か503のいずれか |
| error.message | string | エラーメッセージ。以下のいずれか 404 ・ 西暦/月/日(曜)のデータはありません。503 ・ もしこのメッセージが表示されたら開発者に報告お願いします。 |
{
"error": {
"code": 404,
"message": "2023/07/05(水)のデータ はありません。"
}
}
更新履歴
- 2022/11/22 公開
- 2023/07/05 dateパラメータを追加
- 2023/09/24 lastLoginAtプロパティを追加