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.

Authentifizierung erforderlichBuilder+

client.firearms.headToHead()

Compare two firearms in a head-to-head matchup.

headToHead(params: HeadToHeadParams): Promise<APIResponse<HeadToHead>>
GET/v1/firearms/head-to-head

Builder+

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    First firearm slug

    Max. Länge
    255
    Beispiel
  • stringerforderlich

    Second firearm slug

    Max. Länge
    255
    Beispiel

application/json

  • object

    The response payload.

  • HeadToHeadFirearm

    One of the two compared firearms, as selected: the sixteen columns the verdicts are computed from, snake_case, under their database names.

  • string

    URL-safe slug identifying the firearm. Stable: it is what a mirror keys on.

  • string

    Display name, as the maker writes it.

  • string | null

    Slug of the manufacturer. manufacturerId on the camelCase endpoints.

  • string | null

    Slug of the category. categoryId on the camelCase endpoints.

  • number | null

    Unloaded weight in grams, without magazine.

  • number | null

    Overall length in millimetres.

  • number | null

    Barrel length in millimetres, measured from the breech face.

  • integer | null

    Standard magazine capacity, in rounds.

  • number | null

    Muzzle velocity in metres per second, with the reference load.

  • number | null

    Muzzle energy in joules, with the reference load.

  • number | null

    Effective range in metres.

  • number | null

    Cyclic rate of fire in rounds per minute; null for a semi-automatic or manual action.

  • HeadToHeadFirearm

    One of the two compared firearms, as selected: the sixteen columns the verdicts are computed from, snake_case, under their database names.

  • string

    URL-safe slug identifying the firearm. Stable: it is what a mirror keys on.

  • string

    Display name, as the maker writes it.

  • string | null

    Slug of the manufacturer. manufacturerId on the camelCase endpoints.

  • string | null

    Slug of the category. categoryId on the camelCase endpoints.

  • number | null

    Unloaded weight in grams, without magazine.

  • number | null

    Overall length in millimetres.

  • number | null

    Barrel length in millimetres, measured from the breech face.

  • integer | null

    Standard magazine capacity, in rounds.

  • number | null

    Muzzle velocity in metres per second, with the reference load.

  • number | null

    Muzzle energy in joules, with the reference load.

  • number | null

    Effective range in metres.

  • number | null

    Cyclic rate of fire in rounds per minute; null for a semi-automatic or manual action.

  • object

    One verdict per compared stat, keyed by the stat's camelCase name (weightEmptyG, overallLengthMm, barrelLengthMm, magazineCapacity, muzzleVelocityMps, muzzleEnergyJ, effectiveRangeM, rateOfFireRpm). A stat neither firearm carries is omitted, so the key set is the stats that could be compared.

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

Alle Anfragelimits

Mindeststufe
Builder+
Monatskontingent
25,000/mo
Anfragerate
60/min
Tageslimit
2,000

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.

Caching-Leitfaden

Dieser Aufruf beantwortet bedingte Anfragen. Speichern Sie das ETag einer Antwort und senden Sie es als If-None-Match zurueck: ein unveraenderter Datensatz liefert 304 Not Modified ohne Body. Das zaehlt auf Ihr Minutenlimit, aber nicht auf Ihr Tageskontingent.