Miscellaneous API Endpoints
GET /api/quest/available
Description: Returns ApiQuestAvailableResponse object.
Query Parameters:
NAME | DESCRIPTION | REQUIRED |
---|---|---|
userKey | Account token | no |
GET /api
Description: Health check.
POST /api/metrics/update
Description: Does nothing at all. Requires a body.
JSON Body:
KEY | DESCRIPTION |
---|---|
webgl_version | ”webgl2” |
GET /user/logout
Description: Logs out on the Web client by returning HTML code that deletes the userKey
cookie client-side.
GET /api/config
Description: Returns ApiGetConfigResponse object.
Query Parameters:
NAME | DESCRIPTION | REQUIRED |
---|---|---|
platform | Options: web, windows, android, ios | no |
version | Client version | no |
version2 | Anticheat version | no |
userKey | Account token | no |
isPolledUpdate | Polled | no |
GET /api/leaderboard/live | /api/leaderboard
Description: Returns ApiLeaderboardResponse object.
Query Parameters:
NAME | DESCRIPTION | REQUIRED |
---|---|---|
userKey | Account token | no |
mode | Game mode; options: solo, duo, squad, limited | no |
time | Options: 24h, 7d, 1m, 1y, all (all time) | no |
category | Options: wins, kills, kills_per_round, winrate, time_alive, rounds, top10 | no |
GET /api/poll/available
Description: Returns ApiPollAvailableResponse object.
Query Parameters:
NAME | DESCRIPTION | REQUIRED |
---|---|---|
userKey | Account token | yes |
POST /api/poll/vote/:pollId:
Description: Votes in a poll.
Query Parameters:
NAME | DESCRIPTION | REQUIRED |
---|---|---|
userKey | Account token | yes |
optionId | Selected option | yes |