GunSpec

Categories

Resource class for interacting with the GunSpec Categories API. Wraps all /v1/categories endpoints. Instantiated internally by the GunSpec client and exposed as client.categories.

Auth RequiredExplorer+

List all firearm categories.

list(): Promise<APIResponse<Category[]>>
GET/v1/categories

  • stringheaderrequired

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

  • Category[]

    The response payload.

  • string

    URL-safe slug identifying the category, e.g. pistol.

  • string

    Display name, as the maker writes it.

  • string | null

    Prose summary of the record, where one has been written.

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

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.

This read answers conditional requests. Keep the ETag from a response and send it back as If-None-Match: an unchanged record returns 304 Not Modified with no body, which counts toward your per-minute rate limit but not your daily allowance.