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.fieldCoverage()

Get field coverage statistics across the database. Shows the percentage of firearms that have data for each field, useful for assessing data completeness.

fieldCoverage(): Promise<APIResponse<FieldCoverage>>
GET/v1/stats/field-coverage

Explorer+

  • stringheaderrequired

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

application/json

  • object[]

    The response payload.

  • string

    Which column the row is about, named as the database names it.

  • number

    Share of records, 0 to 100.

  • 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.