Compatibility

Get a platform

A platform with its default interfaces and its member firearms.

Requires Studio tier or higher.

get/v1/platforms/{id}

Request

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

Path parameters

idstring required

Platform slug

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

Get a platform

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.",
    "interfaces": [
      {
        "position": "rear",
        "standardId": "stock:ak-100-folder",
        "name": "AK-100 series polymer side-folder trunnion (AK-74M pattern)",
        "kind": "stock_mount",
        "confidence": 1
      }
    ],
    "members": [
      {
        "id": "ak-74m",
        "name": "AK-74M"
      }
    ]
  }
}

Changes

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