Firearm Analysis

Find similar firearms

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.

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

Path parameters

idstring required

Resource slug ID

Response

Find similar firearms

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": [
    {
      "id": "sig-sauer-p320-full-size",
      "name": "SIG Sauer P320",
      "score": 0.82,
      "manufacturerId": "sig-sauer",
      "categoryId": "pistol",
      "countryOfOrigin": "US",
      "yearIntroduced": 2014,
      "actionType": "short_recoil",
      "images": [
        {
          "id": 2572,
          "url": "https://api.gunspec.io/v1/firearms/ak-47/images/2572",
          "alt": "AK-47 right profile",
          "width": 1536,
          "height": 1024
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.