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

client.stats.featureFrequency()

Get feature frequency statistics across the database.

featureFrequency(params?: FeatureFrequencyParams): Promise<APIResponse<FeatureFrequency[]>>
GET/v1/stats/feature-frequency

Builder+

  • stringheaderrequired

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

  • string

    Restrict to a category slug

    Example
  • integerdefault50

    How many to return

    Range
    1 – 100
    Example

application/json

  • object[]

    The response payload.

  • string

    The feature as stored, and the value to send as feature to /v1/firearms/by-feature.

  • 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

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.