Firearm Discovery

Get available filter values

Returns the distinct values available for each filterable field, for building filter UIs without hardcoding the options. Categories, manufacturers and calibers no firearm uses are omitted.

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

get/v1/firearms/filter-options

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/firearms/filter-options
  • 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 available filter values

successboolean required

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

Example response

{
  "success": true,
  "data": {
    "manufacturers": [
      {
        "id": "glock",
        "name": "Glock",
        "countryCode": "AT"
      }
    ],
    "categories": [
      {
        "slug": "pistol",
        "name": "Pistol"
      }
    ],
    "calibers": [
      {
        "id": "9x19mm-parabellum",
        "name": "9x19mm Parabellum"
      }
    ],
    "actionTypes": [
      {
        "id": "semi_automatic",
        "name": "Semi Automatic"
      }
    ],
    "features": [
      {
        "id": "threaded barrel",
        "name": "Threaded Barrel"
      }
    ]
  }
}

Changes

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