---
title: "Find similar firearms"
method: GET
path: "/v1/firearms/{id}/similar"
tags: ["Firearm Analysis"]
---

# Find similar firearms

`GET /v1/firearms/{id}/similar`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/firearms/{id}/similar`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns the 10 most similar firearms in the same category, scored on shared calibers, manufacturer, action type, weight, barrel length, year, and capacity. Each result inlines its `images` array so a "you may also like" strip can be rendered from this one call.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

## Path parameters

- `id` string, required

## Response `200`

Find similar firearms

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` SimilarFirearm[], required: The response payload.
    - `id` string, required: Slug of the similar firearm.
    - `name` string, required: Display name, as the maker writes it.
    - `score` number, required: How alike the two records are, 0 to 1. Computed from the specifications, not from what people browse together.
    - `manufacturerId` string, nullable: Slug of the manufacturer that makes it. Resolve against `/v1/manufacturers/{id}`.
    - `categoryId` string, nullable: Slug of the category it belongs to. Resolve against `/v1/categories`.
    - `countryOfOrigin` string, nullable: ISO 3166-1 alpha-2 code of where it was designed, e.g. `AT`.
    - `yearIntroduced` integer, nullable: Year it entered production or service. Null where the date is disputed or unknown.
    - `status` 'in_production' | 'discontinued' | 'out_of_production' | 'in_service' | 'limited_production' | 'prototype': Production status of a firearm. Closed: these are every value the catalog holds.
    - `svgLineArtUrl` string, nullable: Line-art silhouette, or null where none has been drawn.
    - `actionType` string, nullable: 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.
    - `images` InlineMediaItem[]: Every image this firearm has, silhouette first. Empty when none are on file.
      - `id` integer, required: Autoincrementing image id.
      - `url` string, required: Absolute, directly fetchable URL.
      - `kind` 'silhouette' | 'render' | 'photo' | 'schematic' | 'model', required: What kind of asset a media row is.
      - `alt` string, nullable: Alt text, where one has been written. Null otherwise, so do not render an empty string.
      - `width` integer, nullable: Pixel width, where it is known.
      - `height` integer, nullable: Pixel height, where it is known.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `404`: Resource not found
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)
