Firearms

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

Search query

Max length

200

Example

glock

Page number, from 1 to 10,000

Range

1 – 10000

Example

1

Items per page (max 100)

Range

1 – 100

Example

20

One search hit. The field names are snake_case here, unlike /v1/firearms and the rest of the catalog: these are the search view's own columns and renaming them would break every consumer already reading them. manufacturer_name and category_name are joined in so a result list renders without a second call.

URL-safe slug identifying the firearm. Stable: it is what a mirror keys on.

Display name, as the maker writes it.

Slug of the manufacturer. manufacturerId on the camelCase endpoints.

Slug of the category. categoryId on the camelCase endpoints.

Display name of the manufacturer, joined in so a result row needs no second call.

Display name of the category.

Slug of the category again, under the name the search view uses. Same value as category_id.

Year the model was introduced.

Production status, one of in_production, discontinued, out_of_production, in_service, limited_production, prototype. Discontinued records are kept deliberately: a rifle built in 2004 wears parts nobody sells today.

ISO 3166-1 alpha-2 code of the country of origin.

Operating action as stored, underscored, e.g. short_recoil, bolt_action, gas_operated. The full vocabulary is /v1/firearms/action-types; a hyphenated value matches nothing.

Unloaded weight in grams, without magazine.

Barrel length in millimetres, measured from the breech face.

Line-art silhouette, or null where none has been drawn.

GLB model, or null where none is on file.

How many accounts have favorited this record.

FTS5 relevance score the page is ordered by. Lower is a better match (SQLite bm25 scores are negative), and it is only comparable within one response. Absent or null when the query fell back to a plain substring match, which has no ranking.

Every image this firearm has, silhouette first. Empty when none are on file.

Autoincrementing image id.

Absolute, directly fetchable URL.

What kind of asset a media row is.

Alt text, where one has been written. Null otherwise, so do not render an empty string.

Pixel width, where it is known.

Pixel height, where it is known.

Current page number

Items per page

Total matching records (Builder and above)