top.gg bot page / documentation
Because of the growing usage of the API the endpoints and accessibility of the API has been made private and is accessible only for donators.
["steam","epic","xbox","psn","switch"]
["unranked","duel","doubles","standard","hoops","rumble","dropshot","snowday","tournament"]
{
"steam_id": "steam id" or null,
"profile_id": "profile id" or null,
"epic_id": "epic id" or null,
"xbox_id": "xbox id" or null,
"psn_id": "psn id" or null,
"switch_id": "switch id" or null,
"primary_id": "depending on the platform one of the _id"
"platform": "one of the platforms",
"name": "players current name in platform",
"custom_name": null,
"ranks": <Ranks Model>,
"peak": <Peaks Model>
}
{
"unranked": 1234
"duel": 1234
"doubles": 1234
"standard": 1234
"hoops": 1234
"rumble": 1234
"dropshot": 1234
"snowday": 1234
"tournament": 1234
"date": "24.05.2020" // included only in the details endpoint
}
{
"seven": 1234,
"thirty": 1234,
"highest": 1234
}
{
"unranked": <Meta Item Model>
"duel": <Meta Item Model>
"doubles": <Meta Item Model>
"standard": <Meta Item Model>
"hoops": <Meta Item Model>
"rumble": <Meta Item Model>
"dropshot": <Meta Item Model>
"snowday": <Meta Item Model>
"tournament": <Meta Item Model>
}
{
"tier": <Tier>,
"division": <Division>
}
{
"min": 1234,
"max": 1234
}
[
"Unranked",
"Bronze I",
"Bronze II",
"Bronze III",
"Silver I",
"Silver II",
"Silver III",
"Gold I",
"Gold II",
"Gold III",
"Platinum I",
"Platinum II",
"Platinum III",
"Diamond I",
"Diamond II",
"Diamond III",
"Champion I",
"Champion II",
"Champion III",
"Grand Champion I",
"Grand Champion II",
"Grand Champion III",
"Supersonic Legend"
]
[
"Division I",
"Division II",
"Division III",
"Division IV"
]
Get current stats for player.
Example response
{
"result": <Player Model>
}
Get users historycal stats, response will be array of <Ranks Model> with the date key for each day
Each day uses value of that days highest mmr.
Example response
{
"result": [
<Ranks Model>,
<Ranks Model>,
<Ranks Model>
]
}
Get users single playlist mmr value.
Playlist key must be one of the described playlist keys.
Example response
{
"result": {
"playlist":"standard",
"value":1234
}
}
Get playlist ranking distribution.
Playlist key must be one of the described playlist keys.
Example response
{
"result": {
"meta": {
"playlist": "standard",
"updated": 1619536793
},
"distribution": {
"Unranked": {
"Division I": <Distribution Model>
},
"Bronze I": {
"Division I": <Distribution Model>,
"Division II": <Distribution Model>,
"Division III": <Distribution Model>,
"Division IV": <Distribution Model>
},
"Bronze II": {
"Division I": <Distribution Model>,
"Division II": <Distribution Model>,
"Division III": <Distribution Model>,
"Division IV": <Distribution Model>
},
...
Every single key from <Tier>
...
}
}
}
Get mutliple user stats at the same time, valid platforms can be used
Example body
{
"steam": [
"steam-id",
"steam-id"
],
"epic": [
"epic-id"
]
}
Example response
{
"result": [
<Player Model>,
<Player Model>,
<Player Model>
]
}
Generate equal teams for custom tournaments.
All premade teams will be filled with randoms.
Premade teams use the same array as the random players array
[
"rank.standard",
"rank.<any key from the Ranks Model>",
"peak.seven",
"peak.<any key from the Peaks Model>"
]
[2, 3, 4]
There are multiple ways how to input the player arrays, all work the same way, this is an example with 1 premade team with 2 users and 4 randoms (for 3v3, 6 players total)
Example body
{
"players": [
{
"primary_id": "steam-id",
"platform": "steam"
},
{
"id": "xbox-id",
"platform": "xbox"
},
{
"steam_id": "steam-id",
},
{
"epic_id": "steam-id",
},
],
"premades": {
"team-1": [
{
"primary_id": "steam-id",
"platform": "steam"
},
{
"xbox_id": "xbox-id"
}
]
},
"comparison": "peak.thirty",
"teamsize": 3
}
Example response
{
"result": [
{
"players": [
<Player Model>,
<Player Model>,
<Player Model>
],
"index": "team-1",
"mmr_total": 2468,
"mmr_average": 1234
},
{
"players": [
<Player Model>,
<Player Model>,
<Player Model>
],
"index": "team-2",
"mmr_total": 2468,
"mmr_average": 1234
}
]
}