client.game.roleRoster()
Get a roster of firearms best suited for a specific game role.
roleRoster(params: RoleRosterParams): Promise<APIResponse<RoleRosterItem[]>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- stringrequired
Gameplay role
- Accepts
- Example
- integerdefault
5How many to return
- Range
- 1 – 25
- Example
- object[]
The best-scoring firearms for the role, strongest first.
- string
Slug of the firearm.
- string
Display name, as the maker writes it.
- number
Fit for this role, 0 to 100, from the role weighting of the game stats.
- object
The editorial game stats, with the
gameprefix the column carries stripped. - integer | null
Editorial damage rating, 0-100. Not a measured figure.
- integer | null
Editorial accuracy rating, 0-100.
- integer | null
Editorial range rating, 0-100.
- integer | null
Editorial rate-of-fire rating, 0-100.
- integer | null
Editorial mobility rating, 0-100.
- integer | null
Editorial recoil-control rating, 0-100.
- integer | null
Editorial reload-speed rating, 0-100.
- integer | null
Editorial concealment rating, 0-100.
- 400
VALIDATION_ERROR - 401
UNAUTHORIZED - 403
FORBIDDEN - 429
RATE_LIMITED - 500
INTERNAL_ERROR
- 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.