Firearms

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

20

Sort field

Akzeptiert

nameweightyearcalibercreated_atfavorites

Beispiel

name

Sort order

Akzeptiert

ascdesc

Beispiel

asc

Comma-separated list of fields to include

Beispiel

id,name,weightEmptyG

Filter by manufacturer slug

Max. Länge

100

Beispiel

glock

Filter by caliber slug

Beispiel

9x19mm-parabellum

Filter by category slug

Max. Länge

100

Beispiel

pistol

Filter by action type, as stored and underscored. The vocabulary is /v1/firearms/action-types

Beispiel

short_recoil

Filter by ISO 3166-1 alpha-2 country code

Beispiel

AT

Minimum year introduced

Maximum year introduced

Minimum empty weight (grams)

Maximum empty weight (grams)

Minimum barrel length (mm)

Filter by production status

Akzeptiert

in_productiondiscontinuedout_of_productionin_servicelimited_productionprototype

Comma-separated feature slugs; all must match

Beispiel

ambi-safety,m-lok

Only firearms with (or without) a 3D model

Akzeptiert

truefalse

Only firearms with (or without) real imagery: a render or a photograph, ignoring the line-art silhouette every firearm has

Akzeptiert

truefalse

Only records added after this ISO 8601 timestamp

Only records added before this ISO 8601 timestamp

One page of results

URL-safe slug identifying the firearm, e.g. glock-17-gen5. Stable: it is what a mirror keys on.

Display name, as the maker writes it.

Slug of the manufacturer that makes it. Resolve against /v1/manufacturers/{id}.

Slug of the category it belongs to. Resolve against /v1/categories.

Year it entered production or service. Null where the date is disputed or unknown.

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 where it was designed, e.g. AT.

How the action cycles: short_recoil, gas_operated, blowback, bolt_action and so on. An open vocabulary: the values in use are published on the schema as x-gunspec-vocabulary, and GET /v1/firearms/action-types is the live list.

Unloaded weight in grams, without magazine.

Barrel length in millimetres, measured from the breech face.

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.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

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.

When a field we serve last changed. Maintained by the database rather than by whatever wrote the row, so it moves for a corrected specification and does not move for a re-run of the importer.

Opaque fingerprint of this record. It changes when and only when a field we serve changes, so a client holding the same value already has the record and need not fetch it. Equality is the only supported operation: do not parse it, and do not assume how it is computed. Null means the record has not been written since versioning began, not that it is unchanged.

Current page number

Items per page

Total matching records (Builder and above)

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Search query

Max. Länge

200

Beispiel

glock

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

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)

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The name to resolve, up to 200 characters.

Max. Länge

200

Beispiel

G19 gen 5 MOS

What one query resolved to.

The query this result answers, echoed back so a batch response can be matched to its request.

One of resolved (exactly one record), ambiguous (several equally good, none chosen) or not_found.

The resolved catalog id. Null on ambiguous and not_found, since an ambiguous query is deliberately not decided for you.

How the resolution was made, or null when nothing resolved. Never fuzzy: a suggestion is not a resolution.

Confidence in the resolution, 0 to 1. Derived from how much of the query a catalogued spelling accounted for and how strong that spelling is as evidence.

The words of the query a catalogued spelling accounted for.

The words it did not. Reported rather than guessed at: a variant we do not hold appears here instead of being silently dropped.

Other records this query could mean, best first. On ambiguous these are the tied candidates and choosing between them is yours.

The catalog id of this candidate.

The catalogued name of this candidate.

The maker, or null where the record has none.

How this candidate was matched. One of slug, name, alternate, shorthand, base (the name with its maker removed), family (the model designation with its trailing descriptor removed, e.g. M4 from M4 Carbine) or fuzzy.

The catalogued spelling that matched, or null for a fuzzy suggestion.

Confidence in this candidate, 0 to 1. Always 0 for a fuzzy suggestion, which is offered rather than scored.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The names to resolve. Between 1 and 50, each up to 200 characters.

The response payload.

One result per query, in the order the queries were sent.

The query this result answers, echoed back so a batch response can be matched to its request.

One of resolved (exactly one record), ambiguous (several equally good, none chosen) or not_found.

The resolved catalog id. Null on ambiguous and not_found, since an ambiguous query is deliberately not decided for you.

How the resolution was made, or null when nothing resolved. Never fuzzy: a suggestion is not a resolution.

Confidence in the resolution, 0 to 1. Derived from how much of the query a catalogued spelling accounted for and how strong that spelling is as evidence.

The words of the query a catalogued spelling accounted for.

The words it did not. Reported rather than guessed at: a variant we do not hold appears here instead of being silently dropped.

Other records this query could mean, best first. On ambiguous these are the tied candidates and choosing between them is yours.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Comma-separated firearm slugs, maximum 5

Beispiel

glock-17-gen5,sig-sauer-p320-full-size

The response payload.

The compared firearms, in the order their ids were given.

Integer flag, 1 when a 3D model is on file. Stored as the database holds it rather than as a boolean.

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

GLB model, or null where none is on file.

The ammunition load ballistics figures are quoted against, where one is nominated.

Muzzle velocity in metres per second exactly as the source stated it, kept beside our own figure so a reader can see what was quoted and what was derived.

Muzzle energy in joules exactly as the source stated it.

Effective range in metres exactly as the source stated it.

Maximum range in metres exactly as the source stated it.

Where the ballistics figures came from, named in prose.

URL of the ballistics source, where it is a page rather than a book.

URL-safe slug identifying the firearm, e.g. glock-17-gen5. Stable: it is what a mirror keys on.

Display name, as the maker writes it.

Per-field differences across the compared firearms, one entry per numeric field.

Which column the row is about, named as the database names it.

This field on each compared firearm, in the order the ids were given. Null where that record does not carry the field.

Lowest value across the compared firearms. Null when fewer than two of them carry the field.

Highest value across the compared firearms. Null when fewer than two of them carry the field.

Spread from the lowest value, as a percentage of it: (max - min) / min * 100, rounded to two places. Null when the minimum is zero or fewer than two records carry the field.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

A firearm as stored: every specification column we serve, with no nested relations. FirearmDetail is this plus them, and /v1/firearms/{id}/family-tree returns this shape for current, since the walk reads the row and does not load the relations.

Integer flag, 1 when a 3D model is on file. Stored as the database holds it rather than as a boolean.

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

GLB model, or null where none is on file.

The ammunition load ballistics figures are quoted against, where one is nominated.

Muzzle velocity in metres per second exactly as the source stated it, kept beside our own figure so a reader can see what was quoted and what was derived.

Muzzle energy in joules exactly as the source stated it.

Effective range in metres exactly as the source stated it.

Maximum range in metres exactly as the source stated it.

Where the ballistics figures came from, named in prose.

URL of the ballistics source, where it is a page rather than a book.

URL-safe slug identifying the firearm, e.g. glock-17-gen5. Stable: it is what a mirror keys on.

Display name, as the maker writes it.

Slug of the manufacturer that makes it. Resolve against /v1/manufacturers/{id}.

Slug of the category it belongs to. Resolve against /v1/categories.

The firearm this one is a variant of, or null when it is not a variant. Variant relationships are what firearm.variant.updated webhooks and /v1/firearms/{id}/variants follow.

How this record differs from its parent: optics_ready, compact, threaded and so on. Null when the record has no parent.

Year it entered production or service. Null where the date is disputed or unknown.

Year production ended, or null while it is still made.

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 where it was designed, e.g. AT.

Unloaded weight in grams, without magazine.

Loaded weight in grams, with a full magazine.

Overall length in millimetres, stock extended where it folds or collapses.

Barrel length in millimetres, measured from the breech face.

Height in millimetres, including sights and a fitted magazine.

Width in millimetres at the widest point.

Distance between front and rear iron sights in millimetres. Null on a record with no iron sights.

How the action cycles: short_recoil, gas_operated, blowback, bolt_action and so on. An open vocabulary: the values in use are published on the schema as x-gunspec-vocabulary, and GET /v1/firearms/action-types is the live list.

What releases the striker or hammer: striker_fired, hammer_fired.

Trigger arrangement: single_action, double_action, safe_action.

Trigger pull weight in newtons. Divide by 4.448 for pounds-force.

Rounds in the standard magazine. Null where the firearm is not magazine-fed.

Magazine pattern: detachable_box, internal, drum, belt.

Muzzle velocity in metres per second, for the default load.

Muzzle energy in joules, for the default load.

Effective range in metres against a point target.

Maximum range in metres. Where the projectile lands, not where it is useful.

Cyclic rate in rounds per minute. Null on anything that is not automatic.

Rifling description, e.g. 6 grooves, right-hand twist.

Rifling twist rate in millimetres per turn. Divide by 25.4 for inches.

Number of grooves cut in the bore.

What the frame or receiver is made of.

What the slide is made of. Null on anything without one.

What the barrel is made of.

What the stock or furniture is made of.

Surface finish, e.g. nitride, parkerized, cerakote.

JSON array of safety mechanisms

JSON array of features

JSON array of feed systems

Editorial game statistic, 0-100. Not a measured figure. These are balance numbers for game use and are not derived from the ballistics above.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

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

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

Person or team credited with the design, where it is known.

Length with stock folded (mm)

JSON array of alternate names/designations

JSON array of firing modes

JSON array of conflict objects with name, years, and sides

JSON object with estimated_total, production_years, and notes

Historical trivia / game-dev flavor text

JSON array of source URLs the record was compiled from. Check a specific figure against these rather than against dataConfidence.

How completely the record is specified and how well it is sourced, 0 to 1. A record-level completeness and provenance measure, not a per-field probability of correctness. Use it to rank and triage; use sources to verify an individual number.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When a field we serve last changed. Maintained by the database rather than by whatever wrote the row, so it moves for a corrected specification and does not move for a re-run of the importer.

Opaque fingerprint of this record. It changes when and only when a field we serve changes, so a client holding the same value already has the record and need not fetch it. Equality is the only supported operation: do not parse it, and do not assume how it is computed. Null means the record has not been written since versioning began, not that it is unchanged.

Where a record's figures came from and how far they have been checked, in one place. sources are the pages consulted; check a specific figure against those. sourceKinds says what each page is and bestSourceKind the strongest of them, on the hierarchy SourceKind defines: a maker or standards-body page is evidence for a figure, a retailer or forum page is evidence the item exists. dataConfidence is the 0 to 1 score set from what was actually sourced and never raised by hand. verifiedAt and verifiedFields say when a source was last read against the record and which fields it stated; null means the row is still seed knowledge. updatedAt and version are the same cache signals the record carries at the top level.

The pages consulted when the record was compiled, as an array. Check a specific figure against these rather than against dataConfidence.

What each cited page is, in sources order, on the SourceKind hierarchy. A host not in the source map is other, never guessed.

The strongest kind among the citations, or null when nothing is cited. manufacturer or standards_body means a figure can be checked against an authority; retailer or community alone means the record is still supported by copies of copies.

The 0 to 1 score set from what was actually sourced, never raised by hand. See the confidence bands in the docs.

When a source was last read against this record. Null means the row is still seed knowledge.

Which fields the source stated, as an array. Everything else on a verified row is still unverified. Null where no source has been read.

Cartridges only: the page the drawing figures were taken from. Null on every other kind of record.

When a served column last changed; the same value the record carries at the top level.

The record's content version, equal to the top-level version; equal versions mean equal data.

Null when the record names a manufacturer id the catalog no longer holds.

Null when the record names a category id the catalog no longer holds.

Every cartridge this firearm is chambered for, primary first.

Slug of the cartridge. Resolve against /v1/calibers/{id}.

Integer flag, 1 on the chambering the firearm is normally sold in. A firearm may be chambered for several cartridges but has at most one primary.

Display name, as the maker writes it.

NATO designation where the cartridge has one, e.g. 9mm NATO. Null otherwise.

Bullet diameter in millimetres.

Case length in millimetres.

Head type: rimmed, rimless, semi_rimmed, rebated_rim, belted, plus historical values like cap_and_ball. Not the broad class. The registry said pistol/rifle/shotgun until the column was read, and it holds neither.

Case neck outside diameter in millimetres.

Bottleneck cases only.

Case base diameter in millimetres, ahead of the extractor groove.

Rim diameter in millimetres.

Rim thickness in millimetres.

Every image on file, silhouette first. Each carries an absolute, directly fetchable url.

Autoincrementing image id. Numeric, unlike the catalog slugs.

Slug of the firearm this row belongs to.

Absolute, directly fetchable URL.

Role of the image: primary, gallery, thumbnail, svg, render.

Where the record came from: a curated entry, an inference, or an import.

Licence the asset is held under, where one is recorded.

What the asset is: silhouette, render, photo, schematic, model. /v1/firearms/{id}/media/{selector} addresses an asset by this.

Where the bytes live: cdn for a static path, r2 for an upload we serve.

Who made the asset, where it is credited.

Page the asset or document was taken from.

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

Pixel width, where it is known.

Forces and agencies that have adopted it.

Autoincrementing row id.

Slug of the firearm this row belongs to.

The force, agency or organisation that adopted it.

What kind of user: military, police, civilian.

ISO 3166-1 alpha-2 code of the user's country.

Year of adoption, where it is known.

What that user calls it, where it differs from the maker's name.

Exploded-view and parts diagrams on file, empty where none have been sourced.

Autoincrementing schematic id.

Slug of the firearm this row belongs to.

What the document is called.

What a schematic document is.

Absolute, directly fetchable URL.

File format, e.g. pdf.

Revision of the document, where the publisher versions it.

Publisher of the document, often but not always the maker.

Where the document came from.

Page the asset or document was taken from.

Who made the asset, where it is credited.

Licence the asset is held under, where one is recorded.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Firearm slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

ak-47

The response payload.

URL-safe slug identifying the firearm, e.g. glock-17-gen5.

Display name, as the maker writes it.

How this record differs from its parent: optics_ready, compact, threaded and so on. Null when the record has no parent.

Year it entered production or service. Null where the date is disputed or unknown.

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.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

The response payload.

Autoincrementing image id. Numeric, unlike the catalog slugs.

Slug of the firearm this row belongs to.

Absolute, directly fetchable URL.

Role of the image: primary, gallery, thumbnail, svg, render.

Where the record came from: a curated entry, an inference, or an import.

Licence the asset is held under, where one is recorded.

What the asset is: silhouette, render, photo, schematic, model. /v1/firearms/{id}/media/{selector} addresses an asset by this.

Where the bytes live: cdn for a static path, r2 for an upload we serve.

Who made the asset, where it is credited.

Page the asset or document was taken from.

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.

Position within its list, ascending.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

Image row id from /v1/firearms/{id}/images

Beispiel

6563

raw file, or a base64 data URI

Akzeptiert

rawdatauri

Beispiel

raw

Pre-rendered derivative; falls back to the original when absent

Akzeptiert

originaldisplaythumb

Beispiel

original

The response payload.

Slug of the firearm the image belongs to.

Numeric id of the image within that firearm image set.

Size rendered: original, display or thumb.

Encoding of the returned image. datauri is the only format this route emits.

Media type of the encoded bytes.

The image inlined as an RFC 2397 data URI, ready to use as an <img src> with no second request.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number

Bereich

1 – 10000

Beispiel

1

Firearms per page

Bereich

1 – 1000

Beispiel

250

Restrict the images on each row to one kind

Akzeptiert

silhouetterenderphotoschematicmodel

One firearm and the real imagery it has. Deliberately three fields: this is the index for a media grid or a mirroring job, not a catalogue row. Silhouettes are excluded: every firearm has one, and they have their own build-time manifest.

Slug of the firearm this row is about.

Display name, as the maker writes it.

The imagery on file for it, silhouette excluded, since every firearm has one of those.

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)

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

Return only one kind of asset

Akzeptiert

silhouetterenderphotoschematicmodel

Beispiel

render

The response payload.

Null for assets stored as a column rather than a row (the 3D model).

What kind of asset a media row is.

Media type of the bytes, e.g. image/png.

Pixel width, where it is known.

Pixel height, where it is known.

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

Absolute, directly fetchable URL.

Per-size URLs. Absent on assets we link rather than host.

URL of the asset at full size.

URL of the mid-size rendition, for a detail page.

URL of the thumbnail rendition, for a list or grid.

Attribution required to reuse the asset. Populated wherever the catalogue records it.

Where the record came from: a curated entry, an inference, or an import.

Who made the asset, where it is credited.

Page the asset or document was taken from.

Licence the asset is held under, where one is recorded.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

Which asset: a kind, which resolves to the primary asset of that kind, or the numeric id of one row from /v1/firearms/{id}/media. Addressing by kind means never having to list first just to learn an id.

Akzeptiert

silhouetterenderphotoschematicmodelor a numeric id

Beispiel

render

Bytes, an inline data URI, or metadata only

Akzeptiert

rawdataurijson

Beispiel

raw

Pre-rendered derivative; falls back to the original when absent

Akzeptiert

fulldisplaythumb

Beispiel

full

Silhouettes only: inject a stroke so line art reads on any background

Bereich

0 – 20

Beispiel

0

Silhouettes only: stroke colour. Any CSS colour the browser understands; quotes, angle brackets, ampersands and backslashes are refused, because the value is written into an SVG attribute

Max. Länge

64

Beispiel

white

One asset belonging to a firearm. Every kind, whether silhouette, render, photo, schematic or 3D model, is returned in this same shape, and url is always absolute and directly fetchable.

Null for assets stored as a column rather than a row (the 3D model).

What kind of asset a media row is.

Media type of the bytes, e.g. image/png.

Pixel width, where it is known.

Pixel height, where it is known.

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

Absolute, directly fetchable URL.

Per-size URLs. Absent on assets we link rather than host.

URL of the asset at full size.

URL of the mid-size rendition, for a detail page.

URL of the thumbnail rendition, for a list or grid.

Attribution required to reuse the asset. Populated wherever the catalogue records it.

Where the record came from: a curated entry, an inference, or an import.

Who made the asset, where it is credited.

Page the asset or document was taken from.

Licence the asset is held under, where one is recorded.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Firearm slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

daniel-defense-mk18-riii

The response payload.

Autoincrementing schematic id.

Slug of the firearm this row belongs to.

What the document is called.

What a schematic document is.

Absolute, directly fetchable URL.

File format, e.g. pdf.

Revision of the document, where the publisher versions it.

Publisher of the document, often but not always the maker.

Where the document came from.

Page the asset or document was taken from.

Who made the asset, where it is credited.

Licence the asset is held under, where one is recorded.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

The response payload.

Autoincrementing row id.

Slug of the firearm this row belongs to.

The force, agency or organisation that adopted it.

What kind of user: military, police, civilian.

ISO 3166-1 alpha-2 code of the user's country.

Year of adoption, where it is known.

What that user calls it, where it differs from the maker's name.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

An SVG file (raw; svg is accepted as the same thing, the name SDK 0.1.x used), an inline data URI, or the SVG source as JSON

Akzeptiert

rawsvgdataurijson

Beispiel

raw

Inject a stroke so the line art reads on any background. 0 leaves it unstroked; anything above 20 is clamped to 20

Bereich

0 – 20

Beispiel

0

Colour of that stroke. Any CSS colour the browser understands: a name, a hex value, rgb(), oklch(), color-mix(). Quotes, angle brackets, ampersands and backslashes are refused, because the value is written into an SVG attribute

Max. Länge

64

Beispiel

white

The response payload.

Slug of the firearm.

Display name, as the maker writes it.

Slug of the line-art file, which is the firearm slug.

Which JSON form this is: datauri or svg.

Media type of the bytes, e.g. image/png.

Present when format=datauri: the SVG inlined as an RFC 2397 data URI.

Present when format=json: the SVG source, for parsing or manipulating in code.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Firearm slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

ak-47

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

Game stats for a firearm plus its derived archetype classification.

Slug of the firearm this profile is for.

Display name, as the maker writes it.

Editorial game statistic, 0-100. Not a measured figure. These are balance numbers for game use and are not derived from the ballistics above.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

Editorial game statistic, 0-100. Not a measured figure.

The role a firearm's game profile assigns it.

The statistics this firearm scores highest on.

The statistics it scores lowest on.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Resource slug ID

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

glock-17-gen5

Physical dimensions in both metric and imperial units.

Slug of the firearm.

Display name, as the maker writes it.

Every dimension in millimetres and grams.

Unloaded weight in grams, without magazine.

Loaded weight in grams, with a full magazine.

Overall length in millimetres, stock extended where it folds or collapses.

Barrel length in millimetres, measured from the breech face.

Height in millimetres, including sights and a fitted magazine.

Width in millimetres at the widest point.

Overall length in millimetres with the stock folded or collapsed. Null where it does not.

The same measurements converted to pounds and inches.

Unloaded weight in pounds, without magazine. Converted from weightEmptyG.

Loaded weight in pounds, with a full magazine. Converted from weightLoadedG.

Overall length in inches, stock extended where it folds or collapses. Converted from overallLengthMm.

Barrel length in inches, measured from the breech face. Converted from barrelLengthMm.

Height in inches, including sights and a fitted magazine. Converted from heightMm.

Width in inches at the widest point. Converted from widthMm.

Overall length in inches with the stock folded or collapsed. Null where it does not. Converted from foldedLengthMm.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Firearm slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

akm

The firearm plus its ancestor and descendant variants, walked recursively.

The parent chain, nearest first, up to 20 deep.

URL-safe slug identifying the related firearm, e.g. type-58.

Display name, as the maker writes it.

Slug of the manufacturer that makes it. Resolve against /v1/manufacturers/{id}.

Slug of the category it belongs to. Resolve against /v1/categories.

The firearm this one is a variant of, or null when it is not a variant. Variant relationships are what firearm.variant.updated webhooks and /v1/firearms/{id}/variants follow.

How this record differs from its parent: optics_ready, compact, threaded and so on. Null when the record has no parent.

Year it entered production or service. Null where the date is disputed or unknown.

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 where it was designed, e.g. AT.

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

When a field we serve last changed. Maintained by the database rather than by whatever wrote the row, so it moves for a corrected specification and does not move for a re-run of the importer.

Opaque fingerprint of this record. It changes when and only when a field we serve changes, so a client holding the same value already has the record and need not fetch it. Equality is the only supported operation: do not parse it, and do not assume how it is computed. Null means the record has not been written since versioning began, not that it is unchanged.

A firearm as stored: every specification column we serve, with no nested relations. FirearmDetail is this plus them, and /v1/firearms/{id}/family-tree returns this shape for current, since the walk reads the row and does not load the relations.

Integer flag, 1 when a 3D model is on file. Stored as the database holds it rather than as a boolean.

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

GLB model, or null where none is on file.

The ammunition load ballistics figures are quoted against, where one is nominated.

Muzzle velocity in metres per second exactly as the source stated it, kept beside our own figure so a reader can see what was quoted and what was derived.

Muzzle energy in joules exactly as the source stated it.

Effective range in metres exactly as the source stated it.

Maximum range in metres exactly as the source stated it.

Where the ballistics figures came from, named in prose.

URL of the ballistics source, where it is a page rather than a book.

URL-safe slug identifying the firearm, e.g. glock-17-gen5. Stable: it is what a mirror keys on.

Display name, as the maker writes it.

Everything derived from it, breadth-first, up to 50 rows.

URL-safe slug identifying the related firearm, e.g. type-58.

Display name, as the maker writes it.

Slug of the manufacturer that makes it. Resolve against /v1/manufacturers/{id}.

Slug of the category it belongs to. Resolve against /v1/categories.

The firearm this one is a variant of, or null when it is not a variant. Variant relationships are what firearm.variant.updated webhooks and /v1/firearms/{id}/variants follow.

How this record differs from its parent: optics_ready, compact, threaded and so on. Null when the record has no parent.

Year it entered production or service. Null where the date is disputed or unknown.

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 where it was designed, e.g. AT.

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

When a field we serve last changed. Maintained by the database rather than by whatever wrote the row, so it moves for a corrected specification and does not move for a re-run of the importer.

Opaque fingerprint of this record. It changes when and only when a field we serve changes, so a client holding the same value already has the record and need not fetch it. Equality is the only supported operation: do not parse it, and do not assume how it is computed. Null means the record has not been written since versioning began, not that it is unchanged.