GunSpec

Game

Resource class for interacting with the GunSpec Game API. Wraps all /v1/game endpoints. These endpoints provide game-balanced firearm data suitable for game development, including normalized stats, tier rankings, and balance analysis. Instantiated internally by the GunSpec client and exposed as client.game.

Auth RequiredBuilder+

client.game.matchups()

Get a game-balanced matchup between two firearms.

matchups(params: MatchupsParams): Promise<APIResponse<MatchupResult>>
GET/v1/game/matchups

Builder+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

  • stringrequired

    First firearm slug

    Max length
    255
    Example
  • stringrequired

    Second firearm slug

    Max length
    255
    Example

application/json

  • object

    The response payload.

  • object

    The firearm named by the a parameter.

  • string

    Slug of the first firearm.

  • string

    Display name, as the maker writes it.

  • object

    The editorial game stats, with the game prefix the column carries stripped.

  • object

    The firearm named by the b parameter.

  • string

    Slug of the second firearm.

  • string

    Display name, as the maker writes it.

  • object

    The editorial game stats, with the game prefix the column carries stripped.

  • object

    The per-stat verdict, keyed by stat rather than listed.

  • string

    Which firearm wins on damage: a, b, or draw.

  • string

    Which firearm wins on accuracy.

  • string

    Which firearm wins on range.

  • string

    Which firearm wins on rate of fire.

  • string

    Which firearm wins on mobility.

  • string

    Which firearm wins on recoil control.

  • string

    Which firearm wins on reload speed.

  • string

    Which firearm wins on concealment.

  • integer

    How many statistics the first firearm wins.

  • integer

    How many statistics the second firearm wins.

  • integer

    How many statistics are tied.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Full rate limits

Minimum tier
Builder+
Monthly quota
25,000/mo
Rate limit
60/min
Daily cap
2,000

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.