Sign in
Records

Returns the latest records.

get/records

Query parameters

topboolean

Only include PBs.

rankedboolean

Only include records set on ranked filters.

string
OR
string

a SteamID

Example:AlphaKeks

Only include records set by this player.

string
OR
integer
Example:Alpha's KZ

Only include records set on this server.

string
OR
integer
Example:kz_checkmate

Only include records set on this map.

coursestring

Only include records set on this course.

mode'vanilla' | 'classic'

Only include records set on this mode.

has_teleportsboolean

Restrict the results to records that (do not) have teleports.

max_rankinteger

The highest rank that any record should have.

This can be used, for example, to query world records only (max_rank=1).

sort_by'submission-date' | 'time'

Which value to sort the results by.

Defaults to 'submission-date'.

sort_order'ascending' | 'descending'

Which direction to sort the results in.

limitinteger
offsetinteger

Response

totalinteger required

The total number of values available for fetching.

Different endpoints have different hard-limits on how many values they will return at a time. They usually also have an offset query parameter you can use to fetch the next set of values. You can use total to infer when you can stop making requests.

Example response

{
  "values": [
    {
      "player": {
        "id": "STEAM_1:1:161178172"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.