Statistics

Get the database summary

Returns headline counts for the catalog: total firearms, manufacturers, calibers, and categories.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

get/v1/stats/summary

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/stats/summary
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

If-None-Matchstring

The ETag from a previous response. If the body would be byte-identical, the API answers 304 Not Modified with no body. A 304 counts toward the per-minute rate limit but not the daily request allowance.

Response

Get the database summary

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "total_firearms": 8629,
    "total_manufacturers": 1112,
    "total_calibers": 605,
    "countries_of_origin": 92,
    "avg_confidence": 74,
    "total_variants": 1350
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.