Endpoint

List games

GET /api/index.json

The entry point. Returns every game in the corpus with its counts and the paths to everything else, so nothing downstream has to be hardcoded.

Response

An object describing the corpus.

schemaVersion	integer	Bumped when the shape of a response changes.
about	string	One paragraph on what the data is.
games	Game[]	One entry per game that has data.
games[].game	string	Slug used in every other path: `valorant`, `lol`.
games[].title	string	Display name.
games[].attribution	string	Who the data came from and under what terms. Stated per game.
games[].entities	integer	How many entities the game holds.
games[].facts	integer	How many facts across those entities.
games[].types	object	Entity type to count. Type names are unique across games.
games[].tiers	object	Provenance tier to count.
games[].paths	object	Where to fetch this game’s entities, fields and codenames.

Request

curl -s -H "x-api-key: $KB_API_KEY" https://kb.play-ascend.com/api/index.json

Response example

{
  "schemaVersion": 3,
  "about": "Structured game data with per-field provenance. Every number carries the source it came from, the tier of that source, and the patch it took effect in. An absent figure is absent on purpose: nothing here is inferred.",
  "games": [
    {
      "game": "valorant",
      "title": "VALORANT",
      "profile": {
        "developer": "Riot Games",
        "publisher": "Riot Games",
        "released": 2020,
        "genre": "tactical hero shooter",
        "modes": [
          "Unrated",
          "Competitive",
          "Swiftplay",
          "Spike Rush",
          "Deathmatch",
          "Team Deathmatch",
          "Premier"
        ]
      },
      "patchSource": {
        "url": "https://playvalorant.com/en-us/news/game-updates/",
        "read": "the VALORANT wiki's patch pages",
        "dating": "bound",
        "caveat": null
      },
      "attribution": "Ability figures are facts extracted from Riot Games' official VALORANT wiki, which is published under CC BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0/); weapon figures come from Riot's shipped weapon data via valorant-api.com. Every value is attributed per field. VALORANT is a trademark of Riot Games, Inc. This project is not affiliated with or endorsed by Riot Games.",
      "entities": 191,
      "facts": 1792,
      "types": {
        "ability": 122,
        "agent": 30,
        "map": 16,
        "system": 2,
        "weapon": 21
      },
      "tiers": {
        "inferred": 2,
        "measured": 46,
        "official_gamefiles": 900,
        "official_ingame": 349,
        "official_patch": 376,
        "unconfirmed": 119
      },
      "paths": {
        "entities": "valorant/entities.json",
        "entity": "valorant/entity/{file}.json",
        "fields": "valorant/fields.json",
        "codenames": "valorant/codenames.json"
      }
    }
  ]
}