GunSpec

Content

Public, key-free reads for GunSpec editorial content: blog posts and the product changelog. Both return only published entries and support pagination and category filtering. Use them to embed news, release notes, or articles directly in your own app.

Auth RequiredExplorer+

Look up a documented operation

Returns what the API reference says about calling an operation: its parameters and what each accepts, the request body, the plan it needs, whether it answers 304 Not Modified, every failure it can return with the error.reason values a client branches on, and the languages a sample is printed in. path may be a documented template (/v1/firearms/{id}), a concrete path (/v1/firearms/glock-g17) or a full URL. A path that names no operation returns the operations under it, so /v1/vendor lists what a seller integration can call. Generated from the reference itself, so it cannot describe an operation differently from the page.

GET/v1/docs/operations

Explorer+

  • stringheaderrequired

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

  • stringrequired

    The operation's path: a documented template, a concrete path or a full URL. A path that names no operation is matched as a prefix.

    Max length
    300
    Example
  • string

    Narrow to one HTTP method. Omitted returns every method the path answers.

    Accepts
    Example

application/json

  • object

    The response payload.

  • string

    exact when the path named an operation, prefix when it did not and these are the operations under it (at most 25).

  • string

    The version of this document the reference was rendered from.

  • object[]

    The matching operations.

  • string

    HTTP method.

  • string

    The documented path template.

  • string

    The operation's title in the reference.

  • string

    What the operation does, as the reference states it.

  • string

    The lowest plan that may call it: public, account (a key attached to a user account), explorer, builder, studio or enterprise.

  • string

    Whether a key is required, optional or not used (none).

  • boolean

    Whether it answers 304 Not Modified to an If-None-Match carrying the ETag it sent.

  • string

    The operation's page in the reference.

  • object[]

    Path, query and header parameters, as the reference lists them.

  • object | null

    The request body, or null for an operation that takes none.

  • object

    What success looks like.

  • object[]

    Every failure the operation documents.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 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.