---
title: "Get the balance report"
method: GET
path: "/v1/game/balance-report"
tags: ["Game"]
---

# Get the balance report

`GET /v1/game/balance-report`

## Request

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

Returns outliers and distribution warnings across the game stat set, for spotting firearms that are over- or under-tuned relative to the rest of the catalog.

**Requires Studio tier or higher.**

## Query parameters

- `threshold` number

## Response `200`

Get the balance report

- 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.
    - `firearmId` string: Slug of the firearm this row belongs to.
    - `firearmName` string: Display name of the firearm this row is about.
    - `deviations` object[]: Every stat on this firearm that sits further from the mean than `threshold`.
      - `stat` string: Which statistic this row is about, named as the field is: `weightEmptyG`, `damage`.
      - `value` number: This firearm value for the stat.
      - `mean` number: Arithmetic mean across the records counted.
      - `stdDev` number: Standard deviation across the records counted.
      - `zScore` number: Standard deviations from the mean. Positive is above it; the sign says which way the firearm is out of line.

## 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.
- `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)