client.firearms.getSimilar()
Get firearms similar to a given firearm.
getSimilar(id: string): Promise<APIResponse<SimilarFirearm[]>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- stringrequired
Resource slug ID
- Accepts
- a lowercase slug: letters, digits and hyphens
- Example
- SimilarFirearm[]
The response payload.
- string
Slug of the similar firearm.
- string
Display name, as the maker writes it.
- number
How alike the two records are, 0 to 1. Computed from the specifications, not from what people browse together.
- string | null
Slug of the manufacturer that makes it. Resolve against
/v1/manufacturers/{id}. - string | null
Slug of the category it belongs to. Resolve against
/v1/categories. - string | null
ISO 3166-1 alpha-2 code of where it was designed, e.g.
AT. - integer | null
Year it entered production or service. Null where the date is disputed or unknown.
- FirearmStatus | null
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. - string | null
Line-art silhouette, or null where none has been drawn.
- string | null
How the action cycles:
short_recoil,gas_operated,blowback,bolt_actionand so on. An open vocabulary: the values in use are published on the schema asx-gunspec-vocabulary, andGET /v1/firearms/action-typesis the live list. - InlineMediaItem[]
Every image this firearm has, silhouette first. Empty when none are on file.
- integer
Autoincrementing image id.
- string
Absolute, directly fetchable URL.
- MediaKind
What kind of asset a media row is.
- string | null
Alt text, where one has been written. Null otherwise, so do not render an empty string.
- integer | null
Pixel width, where it is known.
- integer | null
Pixel height, where it is known.
- 400
VALIDATION_ERROR - 401
UNAUTHORIZED - 403
FORBIDDEN - 404
NOT_FOUND - 429
RATE_LIMITED - 500
INTERNAL_ERROR
- 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.