---
title: "Compare two firearms on game stats"
method: GET
path: "/v1/game/matchups"
tags: ["Game"]
---

# Compare two firearms on game stats

`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

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

**Requires Builder tier or higher.**

## Query parameters

- `a` string, required
- `b` string, required

## Response `200`

Compare two firearms on game stats

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` object, required: The response payload.
    - `a` object: The firearm named by the `a` parameter.
      - `id` string: Slug of the first firearm.
      - `name` string: Display name, as the maker writes it.
      - `stats` object: The editorial game stats, with the `game` prefix the column carries stripped.
        - `damage` integer, nullable: Editorial damage rating, 0-100. Not a measured figure.
        - `accuracy` integer, nullable: Editorial accuracy rating, 0-100.
        - `range` integer, nullable: Editorial range rating, 0-100.
        - `fireRate` integer, nullable: Editorial rate-of-fire rating, 0-100.
        - `mobility` integer, nullable: Editorial mobility rating, 0-100.
        - `recoilControl` integer, nullable: Editorial recoil-control rating, 0-100.
        - `reloadSpeed` integer, nullable: Editorial reload-speed rating, 0-100.
        - `concealment` integer, nullable: Editorial concealment rating, 0-100.
    - `b` object: The firearm named by the `b` parameter.
      - `id` string: Slug of the second firearm.
      - `name` string: Display name, as the maker writes it.
      - `stats` object: The editorial game stats, with the `game` prefix the column carries stripped.
        - `damage` integer, nullable: Editorial damage rating, 0-100. Not a measured figure.
        - `accuracy` integer, nullable: Editorial accuracy rating, 0-100.
        - `range` integer, nullable: Editorial range rating, 0-100.
        - `fireRate` integer, nullable: Editorial rate-of-fire rating, 0-100.
        - `mobility` integer, nullable: Editorial mobility rating, 0-100.
        - `recoilControl` integer, nullable: Editorial recoil-control rating, 0-100.
        - `reloadSpeed` integer, nullable: Editorial reload-speed rating, 0-100.
        - `concealment` integer, nullable: Editorial concealment rating, 0-100.
    - `verdicts` object: The per-stat verdict, keyed by stat rather than listed.
      - `damage` string: Which firearm wins on damage: `a`, `b`, or `draw`.
      - `accuracy` string: Which firearm wins on accuracy.
      - `range` string: Which firearm wins on range.
      - `fireRate` string: Which firearm wins on rate of fire.
      - `mobility` string: Which firearm wins on mobility.
      - `recoilControl` string: Which firearm wins on recoil control.
      - `reloadSpeed` string: Which firearm wins on reload speed.
      - `concealment` string: Which firearm wins on concealment.
    - `aWins` integer: How many statistics the first firearm wins.
    - `bWins` integer: How many statistics the second firearm wins.
    - `draws` integer: How many statistics are tied.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `404`: Resource not found
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)