Docs

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

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

/v1/firearms/{id}

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

Accepts

GETPOSTPUTPATCHDELETE

Example

GET

The response payload.

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

The version of this document the reference was rendered from.

The matching operations.

HTTP method.

The documented path template.

The operation's title in the reference.

What the operation does, as the reference states it.

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

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

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

The operation's page in the reference.

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

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

What success looks like.

Every failure the operation documents.