GunSpec

Firearms

Resource class for interacting with the GunSpec Firearms API. Wraps all /v1/firearms endpoints. Instantiated internally by the GunSpec client and exposed as client.firearms.

Auth RequiredStudio+

client.firearms.getSchematics()

Get the technical schematics for a firearm. Returns exploded-view and cutaway drawings with their attribution.

getSchematics(id: string): Promise<APIResponse<FirearmSchematic[]>>
GET/v1/firearms/{id}/schematics

Studio+

  • stringheaderrequired

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

  • stringrequired

    Firearm slug

    Accepts
    a lowercase slug: letters, digits and hyphens
    Example

application/json

  • FirearmSchematic[]

    The response payload.

  • integer

    Autoincrementing schematic id.

  • string

    Slug of the firearm this row belongs to.

  • string

    What the document is called.

  • SchematicType

    What a schematic document is.

  • string

    Absolute, directly fetchable URL.

  • string | null

    File format, e.g. pdf.

  • string | null

    Revision of the document, where the publisher versions it.

  • string | null

    Publisher of the document, often but not always the maker.

  • string | null

    Where the document came from.

  • string | null

    Page the asset or document was taken from.

  • string | null

    Who made the asset, where it is credited.

  • string | null

    Licence the asset is held under, where one is recorded.

  • string

    When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 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.