Compatibility

Get a firearm's mount interfaces

The mount points a firearm exposes (muzzle thread, rails, optic cut, stock and grip interfaces, magazine well), resolved from its own rows, its parent chain and its platforms. Each row carries where it came from and a confidence, so an inferred claim is never mistaken for a verified one. This is what a builder UI draws its slot panel from.

Requires Studio tier or higher.

get/v1/firearms/{id}/interfaces

Request

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

Path parameters

idstring required

Firearm slug

Response

Get a firearm's mount interfaces

successboolean required

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

Example response

{
  "success": true,
  "data": {
    "firearm": {
      "id": "ak-74m",
      "name": "AK-74M"
    },
    "platforms": [
      {
        "id": "ak-100",
        "name": "AK-100 series (AK-74M pattern)"
      }
    ],
    "interfaces": [
      {
        "position": "muzzle",
        "standardId": "thread:m24x1.5-rh",
        "name": "M24x1.5 right hand (AK-74, AK-100 series)",
        "kind": "thread",
        "confidence": 1
      }
    ]
  }
}

Changes

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