GunSpec

Stats

Resource class for interacting with the GunSpec Statistics API. Wraps all /v1/stats endpoints. Instantiated internally by the GunSpec client and exposed as client.stats.

Auth RequiredExplorer+

client.stats.byCategory()

Get firearm counts grouped by category.

byCategory(): Promise<APIResponse<CategoryStats[]>>
GET/v1/stats/by-category

Explorer+

  • stringheaderrequired

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

application/json

  • object[]

    The response payload.

  • string

    Slug of the category.

  • string

    Display name, as the maker writes it.

  • integer

    How many catalogued firearms are in it.

  • number | null

    Mean unloaded weight in grams across the category, over the firearms that record one.

  • number | null

    Mean magazine capacity across the category, over the firearms that record one.

  • number | null

    Mean barrel length in millimetres across the category, over the firearms that record one.

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

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

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