Game

Compare two firearms on game stats

Returns a per-stat verdict between two firearms using their game-balance stats, plus the overall tally.

Requires Builder tier or higher.

get/v1/game/matchups

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/game/matchups
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

astring required

First firearm slug

bstring required

Second firearm slug

Response

Compare two firearms on game stats

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "a": {
      "id": "ak-47",
      "name": "AK-47",
      "stats": {
        "damage": 72,
        "accuracy": 64,
        "range": 58,
        "fireRate": 70,
        "mobility": 55,
        "recoilControl": 48,
        "reloadSpeed": 60,
        "concealment": 30
      }
    },
    "b": {
      "id": "m16a1",
      "name": "M16A1",
      "stats": {
        "damage": 72,
        "accuracy": 64,
        "range": 58,
        "fireRate": 70,
        "mobility": 55,
        "recoilControl": 48,
        "reloadSpeed": 60,
        "concealment": 30
      }
    },
    "verdicts": {
      "damage": "a",
      "accuracy": "b",
      "range": "draw",
      "fireRate": "a",
      "mobility": "b",
      "recoilControl": "b",
      "reloadSpeed": "a",
      "concealment": "b"
    },
    "aWins": 4,
    "bWins": 3,
    "draws": 1
  }
}

Changes

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