GunSpec

Platforms

Platforms resource for the GunSpec SDK. Wraps /v1/platforms: the families (ak-100, ar-15) whose interface rows every member inherits. One row on a platform reaches every firearm that belongs to it, which is the lever behind most computed fits. Studio.

Auth RequiredStudio+

client.platforms.list()

Every platform with its member count. Answers 304.

list(): Promise<APIResponse<Platform[]>>
GET/v1/platforms

Studio+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

application/json

  • object[]

    The response payload.

  • string

    Slug of the platform.

  • string

    Display name, as the maker writes it.

  • string | null

    Prose summary of the record, where one has been written.

  • integer

    How many firearms belong to the platform.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Full rate limits

Minimum tier
Studio+
Monthly quota
150,000/mo
Rate limit
120/min
Daily cap
10,000

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.

Caching guide

This read answers conditional requests. Keep the ETag from a response and send it back as If-None-Match: an unchanged record returns 304 Not Modified with no body, which counts toward your per-minute rate limit but not your daily allowance.