GunSpec

Interfaces

Interface standards resource for the GunSpec SDK. Wraps /v1/interfaces: the mount vocabulary every fit is computed from (thread:1/2x28, mag:stanag, rail:picatinny). Listing it is open; asking which firearms expose a standard is Studio.

Auth RequiredExplorer+

client.interfaces.list()

Every standard the vocabulary knows, optionally one kind only. Answers 304.

list(params?: ListInterfacesParams): Promise<APIResponse<InterfaceStandard[]>>
GET/v1/interfaces

Explorer+

  • stringheaderrequired

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

  • string

    One kind only

    Max length
    40
    Example

application/json

  • InterfaceStandard[]

    The response payload.

  • string

    Kind-prefixed standard id, e.g. thread:1/2x28. URL-encode it when addressing /v1/interfaces/{id}/firearms.

  • string

    What sort of interface it is: thread, rail, mag, stock_mount, optic_plate.

  • string

    Display name, as the maker writes it.

  • string[]

    JSON array of alternative spellings of this standard id, as a string. Ids are never renamed; a new spelling becomes an alias.

  • string | null

    Free-text notes that do not belong in a specific field.

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

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

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.