GET leaderboards

Gets a list of Crypt of the NecroDancer leaderboards.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
products

Valid values are 'classic' and 'amplified'. If not provided, returns leaderboards from all products.

Object []

Required

modes

Valid values are 'standard', 'no-return', 'hard', 'phasing', 'randomzier', and 'mystery'. If not provided, returns leaderboards from all modes.

Object []

Required

runs

Valid values are 'score', 'speed', 'seeded-score', 'seeded-speed', and 'deathless'. If not provided, returns leaderboards from all runs.

Object []

Required

characters

Valid values are 'all-characters', 'all-characters-amplified', 'aria', 'bard', 'bolt', 'cadence', 'coda', 'diamond', 'dorian', 'dove', 'eli', 'mary', 'melody', 'monk', 'nocturna', 'story-mode', and 'tempo'. If not provided, returns leaderboards from all characters.

Object []

Required

production

If true, returns production leaderboards. If false, returns Early Access leaderboards. If not provided, returns both production and Early Access leaderboards.

boolean

coOp

If true, returns Co-op leaderboards. If false, returns non-Co-op leaderboards. If not provided, returns both Co-op and non-Co-op leaderboards.

boolean

customMusic

If true, returns Custom Music leaderboards. If false, returns non-Custom Music leaderboards. If not provided, returns both Custom Music and non-Custom Music leaderboards.

boolean

Response Information

Resource Description

Returns a list of Crypt of the NecroDancer leaderboards.

LeaderboardsEnvelope
NameDescriptionTypeAdditional information
total

Total number of leaderboards.

integer

leaderboards

A collection of leaderboards.

Leaderboard[]

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "leaderboards": [
    {
      "id": 1,
      "updated_at": "2020-07-12T09:02:18.5088235Z",
      "name": "sample string 2",
      "display_name": "sample string 3",
      "production": true,
      "product": "sample string 5",
      "_product": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "mode": "sample string 6",
      "_mode": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "run": "sample string 7",
      "_run": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "character": "sample string 8",
      "_character": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "coOp": true,
      "customMusic": true,
      "total": 11
    },
    {
      "id": 1,
      "updated_at": "2020-07-12T09:02:18.5088235Z",
      "name": "sample string 2",
      "display_name": "sample string 3",
      "production": true,
      "product": "sample string 5",
      "_product": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "mode": "sample string 6",
      "_mode": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "run": "sample string 7",
      "_run": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "character": "sample string 8",
      "_character": {
        "id": 1,
        "name": "sample string 2",
        "display_name": "sample string 3"
      },
      "coOp": true,
      "customMusic": true,
      "total": 11
    }
  ]
}