# Ranks List

> `GET /api/academy/ranks`: Academy endpoint of the Rone Arena API.

Retrieve all rank information for Mobile Legends: Bang Bang. Supports query parameters for pagination and localization.

Query parameters:
- **size**: Number of items per page (minimum: 1).
- **index**: Page index (starting from 1).
- **lang**: Language code for localized content (default: `en`).

The response includes rank data:
- **records**: Array of rank entries, each containing:
    - **_id**: Unique record identifier.
    - **configId**: Configuration ID.
    - **caption**: Localized caption (e.g., '1-4勇士Ⅲ').
    - **createdAt**: Creation timestamp.
    - **createdUser**: Creator username.
    - **updatedAt**: Last update timestamp.
    - **updatedUser**: Last updater username.
    - **data**:
        - **bigrank**: Major rank ID (e.g., 1).
        - **bigrank_name**: Major rank name (e.g., '勇士').
        - **icon**: Rank icon URL.
        - **minrank**: Minor rank ID (e.g., '1').
        - **minrank_name**: Minor rank name (e.g., 'Ⅲ').
        - **rankid_start**: Starting rank ID in the range.
        - **rankid_end**: Ending rank ID in the range.
    - **id**: Internal record ID.
    - **sort**: Sorting index.

This endpoint is useful for:
- Displaying the full rank progression system.
- Explaining rank tiers and ranges.
- Guiding players in understanding the game's ranking structure.

## Request

`GET https://arena.rone.dev/api/academy/ranks`

### Parameters

| Name | In | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `size` | query | integer | no | `20` | Number of items per page. Range: 1... |
| `index` | query | integer | no | `1` | Page index for pagination. Range: 1... |
| `lang` | query | string | no | `en` | Language code for localized content. One of: `en`, `id`, `ru`, `es`, `pt`, `tr`, `ar`, `de`, `fr`, `it`, `ja`, `ko`, `th`, `vi`, `zh-CN`, `zh-TW`, `km`. |

### Example

```bash
curl -X GET 'https://arena.rone.dev/api/academy/ranks'
```

## Example response

```json
{
  "code": 0,
  "message": "OK",
  "data": {
    "records": [
      {
        "_id": "6908a30ee594c8676a88ed72",
        "configId": 144237,
        "id": 3210595,
        "caption": "1-4\u52c7\u58eb\u2162",
        "data": {
          "_object": 3210429,
          "bigrank": 1,
          "bigrank_name": "\u52c7\u58eb",
          "icon": "https://wsrv.nl/?url=https%3A%2F%2Fakmweb.youngjoygame.com%2Fweb%2Fgms%2Fimage%2Fe8659ed5040a378701beca13ebdc4fba.png",
          "minrank": "1",
          "minrank_name": "\u2162",
          "rankid_end": 4,
          "rankid_start": 1
        },
        "createdUser": "v_xyxu",
        "createdAt": 1762173710696,
        "updatedAt": 1762173714202,
        "updatedUser": "v_xyxu",
        "sort": 0
      }
    ],
    "total": 29
  }
}
```

## Links

- Try it in the playground: https://arena.rone.dev/web/academy/ranks
- Academy endpoints: https://arena.rone.dev/web/academy.md
- OpenAPI schema: https://arena.rone.dev/api/openapi.json