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 erforderlichExplorer+

client.firearms.getUsers()

Get known military/law-enforcement adopters of a firearm.

getUsers(id: string): Promise<APIResponse<FirearmUser[]>>
GET/v1/firearms/{id}/users

Explorer+

  • stringHeadererforderlich

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

  • stringerforderlich

    Resource slug ID

    Akzeptiert
    a lowercase slug: letters, digits and hyphens
    Beispiel

application/json

  • FirearmUser[]

    The response payload.

  • integer

    Autoincrementing row id.

  • string

    Slug of the firearm this row belongs to.

  • string

    The force, agency or organisation that adopted it.

  • string | null

    What kind of user: military, police, civilian.

  • string | null

    ISO 3166-1 alpha-2 code of the user's country.

  • integer | null

    Year of adoption, where it is known.

  • string | null

    What that user calls it, where it differs from the maker's name.

  • 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
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

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