Compatibility

List platforms

Groups of firearms that share mount interfaces by construction (AKM-pattern stamped receivers, mil-spec AR-15s, Gen5 9mm Glocks). A platform's default interfaces are inherited by every member unless the member declares its own for that position.

Requires Studio tier or higher.

get/v1/platforms

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/platforms
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

If-None-Matchstring

The ETag from a previous response. If the body would be byte-identical, the API answers 304 Not Modified with no body. A 304 counts toward the per-minute rate limit but not the daily request allowance.

Response

List platforms

successboolean required

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

Example response

{
  "success": true,
  "data": [
    {
      "id": "ak-100",
      "name": "AK-100 series (AK-74M pattern)",
      "description": "AK-74M and its export family.",
      "memberCount": 11
    }
  ]
}

Changes

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