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.getMedia()

Metadata for one asset, by kind or by row id. Builder.

getMedia(id: string, selector: MediaKind | number | string, params?: GetFirearmMediaParams): Promise<APIResponse<FirearmMedia>>
GET/v1/firearms/{id}/media/{selector}

Builder+

  • stringHeadererforderlich

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

  • stringerforderlich

    Resource slug ID

    Akzeptiert
    a lowercase slug: letters, digits and hyphens
    Beispiel
  • unknownerforderlich

    Which asset: a kind, which resolves to the primary asset of that kind, or the numeric id of one row from /v1/firearms/{id}/media. Addressing by kind means never having to list first just to learn an id.

    Akzeptiert
    or a numeric id
    Beispiel

Das Beispiel fragt glock-g17-gen5 ab. Diesen Datensatz auf gunspec.io ansehen, für Menschen dargestellt.

  • stringstandardraw

    Bytes, an inline data URI, or metadata only

    Akzeptiert
    Beispiel
  • stringstandarddisplay

    WebP by default: display is full size with transparency, thumb a small preview, full the uploaded file (usually PNG). A missing derivative falls back to the original

    Akzeptiert
    Beispiel
  • integerstandard0

    Silhouettes only: inject a stroke so line art reads on any background

    Bereich
    0 – 20
    Beispiel
  • stringstandardblack

    Silhouettes only: stroke colour. Any CSS colour the browser understands; quotes, angle brackets, ampersands and backslashes are refused, because the value is written into an SVG attribute

    Max. Länge
    64
    Beispiel

application/json

  • MediaItem

    One asset belonging to a firearm. Every kind, whether silhouette, render, photo, schematic or 3D model, is returned in this same shape, and url is always absolute and directly fetchable.

  • integer | null

    Null for assets stored as a column rather than a row (the 3D model).

  • MediaItemKind

    What kind of asset a media listing item is: a stored kind, or feature_icon, the drawn icon for one of the firearm's features.

  • string

    On a feature_icon only: the tag in the firearm's features this drawing illustrates, exactly as the record carries it.

  • string | null

    Media type of the bytes, e.g. image/png.

  • integer | null

    Pixel width, where it is known.

  • integer | null

    Pixel height, where it is known.

  • string | null

    Alt text, where one has been written. Null otherwise, so do not render an empty string.

  • string

    Absolute, directly fetchable URL.

  • object

    Per-size URLs. Absent on assets we link rather than host.

  • string

    URL of the asset at full size.

  • string

    URL of the mid-size rendition, for a detail page.

  • string

    URL of the thumbnail rendition, for a list or grid.

  • object

    Attribution required to reuse the asset. Populated wherever the catalogue records it.

  • string | null

    Where the record came from: a curated entry, an inference, or an import.

  • string | null

    Who made the asset, where it is credited.

  • string | null

    Page the asset or document was taken from.

  • string | null

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

  • 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
5,000

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