GET User Frequent Heroes
/openmlbb/user/heroes/frequent
API Path: /api/user/heroes/frequent
Retrieve the authenticated player's frequent heroes information using a valid JWT. Supports query parameters for season filtering, pagination, and localization. Requires an Authorization header with the JWT from login.
Headers:
- Authorization:
Bearer <jwt>(JWT obtained during login).
Query parameters:
- sid: Season ID for filtering frequent heroes (must be a valid season ID from
/api/user/season). - limit: Maximum number of heroes to retrieve (minimum: 1).
- last_cursor: Cursor for pagination. Use the value from
pageInfo.nextCursorin the current response. IfpageInfo.hasNextisfalseorpageInfo.nextCursoris empty, there is no next page. - lang: Language code for localized content (default:
en).
The response includes frequent hero usage details:
- hid: Hero ID.
- tc: Total Count (number of matches played with this hero).
- wc: Win Count (number of matches won with this hero).
- bs: Battle Score (average performance rating,
bs/100). - mr: Match Rating (accumulated rating points).
- mrp: Match Rating Percentage (rating contribution relative to overall performance).
- hid_e: Hero entity metadata:
- id: Hero ID.
- n: Hero name.
- ix: Hero image URL.
- i2x: Large hero image URL.
- p: Power score (weighted performance index for ranking frequent heroes, also called
MMR).
Pagination example:
First request: /api/user/heroes/frequent?sid=37&limit=5&lang=en → response includes pageInfo.nextCursor = 11.
Second request: /api/user/heroes/frequent?sid=37&limit=5&last_cursor=11&lang=en → retrieves the next page, using pageInfo.nextCursor from the current response.
Stop pagination when pageInfo.hasNext = false or pageInfo.nextCursor is empty.
The response also includes pagination metadata:
- pageInfo.nextCursor: Cursor value for the next page.
- pageInfo.hasNext: Boolean flag indicating if more results are available.
- pageInfo.count: Number of results returned in the current page.
This endpoint is useful for:
- Analyzing which heroes a player uses most often.
- Tracking win rates and performance scores.
- Comparing hero usage across different seasons.
This endpoint requires JWT. Pass the token via the SDK call argument jwt="YOUR_JWT".
Python Example
from OpenMLBB import OpenMLBB
client = OpenMLBB()
response = client.user.heroes_frequent(jwt="YOUR_JWT", sid=1, limit=5, last_cursor="value", lang="en")
print(response)
Path and Query Parameters
| Name | In | Type | Required | Default |
|---|---|---|---|---|
| sid | query | integer | yes | - |
| limit | query | integer | no | 5 |
| last_cursor | query | string | no | - |
| lang | query | string | no | en |