Compatibility

List firearms exposing a standard

Every firearm that exposes the interface standard, directly or through a platform, confirmed through the resolver so a member that has declared none for the position is not listed. The id is URL-encoded: thread%3A1%2F2x28.

Requires Studio tier or higher.

get/v1/interfaces/{id}/firearms

Request

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

Path parameters

idstring required

Interface standard id. URL-encode it in the path: the colon and any slash must be escaped, so thread:1/2x28 is sent as thread%3A1%2F2x28

Query parameters

pageinteger

Page number, from 1 to 10,000

per_pageinteger

Items per page (max 100)

Response

List firearms exposing a standard

successboolean required

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

Example response

{
  "success": true,
  "data": [
    {
      "id": "m4a1-carbine",
      "name": "M4A1 Carbine",
      "position": "muzzle",
      "confidence": 1,
      "manufacturer": {
        "id": "magpul",
        "name": "Magpul Industries"
      },
      "category": "Assault Rifle",
      "images": [
        {
          "id": 2572,
          "url": "https://api.gunspec.io/v1/firearms/ak-47/images/2572",
          "alt": "AK-47 right profile",
          "width": 1536,
          "height": 1024
        }
      ],
      "svgLineArtUrl": "https://api.gunspec.io/v1/firearms/m4a1-carbine/media/silhouette",
      "yearIntroduced": 1994
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

Changes

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