STORMGATE API

This document describes the HTTP endpoints and methods that make up the public API for various Stormgate datasets provided by Untapped.gg.

USAGE LIMITS

You are free to access these APIs without authentication. There is a rate limit of no more than 20 requests per minute to any of the public API endpoints. If you have a use case that needs a higher request limit, please email data@frostgiant.com.

Note that due to Cross-Origin Resource Sharing protections you will need to run your own proxy or script to fetch the data from this API. We will not consider whitelist requests at this time.

LEADERBOARD

Returns the top 500 players by points, descending for the specified ranked match mode. Currently, only ranked_1v1 is supported as a value for match_mode.

Positions on the leaderboard are updated on a 1 minute period.

GET https://api.stormgate.untapped.gg/api/v1/leaderboard?match_mode=ranked_1v1

Response

[
  {
    "race": "infernals",
    "points": 2530.9366,
    "wins": 343,
    "losses": 15,
    "ties": 0,
    "league": "grandmaster",
    "tier": null,
    "mmr": 2513.1244,
    "playerName": "HorsePasta",
    "profileId": "At4X3hJ"
  },
  …
]

PLAYER SEARCH

Retrieve information about Stormgate players by display name.

If the search term includes the # character, a full match will be performed against the player's display name and discriminator.

Otherwise, a match will be performed against the player's full display name, not including discriminator, and all records with a matching display name will be returned.

Display name matching is case-insensitive.

Note: This API may currently take longer to update than the leaderboard.

GET https://api.stormgate.untapped.gg/api/v1/players?q=HorsePasta

Response

[
  {
    "playerName": "HorsePasta",
    "profileId": "At4X3hJ",
    "ranks": {
      "ranked_1v1": {
        "infernals": {
          "mmr": 2513.1244,
          "tier": null,
          "ties": 0,
          "wins": 343,
          "league": "grandmaster",
          "losses": 15,
          "points": 2530.9366,
          "season": 1
        }
      }
    }
  },
  …
]

PLAYER LOOKUP

Retrieve information about a single Stormgate player, identified by Untapped.gg profile id.

(See above.)

Note: This API may currently take longer to update than the leaderboard.

GET https://api.stormgate.untapped.gg/api/v1/players/{profileId}

Response

{
  "playerName": "HorsePasta",
  "profileId": "At4X3hJ",
  "ranks": {
    "ranked_1v1": {
      "infernals": {
        "mmr": 2513.1244,
        "tier": null,
        "ties": 0,
        "wins": 343,
        "league": "grandmaster",
        "losses": 15,
        "points": 2530.9366,
        "season": 1
      }
    }
  }
}