GunSpec

DataQuality

Resource class for interacting with the GunSpec Data Quality API. Wraps all /v1/data endpoints. Instantiated internally by the GunSpec client and exposed as client.dataQuality.

Auth RequiredEnterprise

Get overall data coverage statistics for the database. Returns per-field and aggregate coverage metrics showing what percentage of records have data for each field.

coverage(): Promise<APIResponse<DataCoverage>>
GET/v1/data/coverage

  • stringheaderrequired

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

  • object

    The response payload.

  • object

    Per-field completeness across the firearms table.

  • integer

    Total records matching the query across every page.

  • object

    Per-field completeness, keyed by column name.

  • object

    Per-field completeness across the calibers table.

  • integer

    Total records matching the query across every page.

  • object

    Per-field completeness, keyed by column name.

  • object

    Per-field completeness across the manufacturers table.

  • integer

    Total records matching the query across every page.

  • object

    Per-field completeness, keyed by column name.

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

Minimum tier
Enterprise
Monthly quota
1,000,000/mo
Rate limit
300/min
Daily cap
50,000

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