Firearms

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

Firearm slug

Accepts

a lowercase slug: letters, digits and hyphens

Example

ak-74m

Attachment category

Max length

100

Example

stock

Manufacturer slug

Max length

100

Example

magpul

compatible (default) or all to include blocked candidates with blockedBy

Accepts

compatibleall

Example

compatible

Hide fits computed through interfaces below this confidence

Range

0 – 1

Example

0

Restrict to one seller. me resolves to the vendor your key belongs to

Max length

64

Example

me

Drop anything that seller does not currently stock. Needs a resolvable vendor, and yields nothing without one

Attach each item's live offers under offers, keyed by attachment id, so price and stock render beside fitment in one call

The response payload.

A firearm, identified by slug and name.

Slug of the firearm.

Display name, as the maker writes it.

Platforms this firearm belongs to, whose interfaces it inherits.

Slug of the platform.

Display name, as the maker writes it.

The mount interfaces resolved for this firearm, own rows first, then inherited.

Where on the firearm the interface sits: muzzle, rear, top, bottom.

Id of the interface standard, kind-prefixed, e.g. thread:1/2x28. Ids are never renamed; new spellings become aliases.

Display name, as the maker writes it.

What sort of interface it is: thread, rail, mag, stock_mount, optic_plate. Not a media kind: the shared registry filled this with silhouette/render until the consistency check caught it.

Where an interface row on a firearm came from. curated is a person; inferred is the backfill, capped at 0.6 confidence; the inherited kinds came through the parent chain or a platform.

How well evidenced this row is, 0 to 1. A minimum, not an average: an inferred row caps every fit computed through it, and min_confidence on the endpoint hides rows below a threshold.

The parent firearm or platform this interface came from, or null when the firearm declares it itself.

Free-text notes that do not belong in a specific field.

Fitting attachments grouped by category, so a builder UI renders one panel per slot.

Attachment category this group holds.

The rows this response carries.

Fitting attachments per category

With with_offers=true, live offers keyed by attachment id, the same rows /v1/attachments/{id}/offers returns; null when not requested.

Total records matching the query across every page.