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 RequiredStudio+

Get statistics about materials used across all firearms.

materials(): Promise<APIResponse<MaterialStats>>
GET/v1/stats/materials

  • stringheaderrequired

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

  • object

    The response payload.

  • object[]

    Frame materials, and how many firearms use each.

  • string

    The material as recorded on the firearm.

  • integer

    How many records fall in this bucket.

  • object[]

    Slide materials, and how many firearms use each.

  • string

    The material as recorded on the firearm.

  • integer

    How many records fall in this bucket.

  • object[]

    Barrel materials, and how many firearms use each.

  • string

    The material as recorded on the firearm.

  • integer

    How many records fall in this bucket.

  • object[]

    Stock materials, and how many firearms use each.

  • string

    The material as recorded on the firearm.

  • integer

    How many records fall in this bucket.

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

Minimum tier
Studio+
Monthly quota
150,000/mo
Rate limit
120/min
Daily cap
10,000

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