GunSpec

Collections

Read a publicly shared, user-curated collection of firearms by its share ID. No API key required. Collections are created and edited from the GunSpec dashboard; only collections set to public are resolvable here.

Authentifizierung optionalExplorer+

Get Shared Collection

Returns a user collection that has been shared publicly, together with the firearms in it. The 10-character share id is the only credential; unshared collections are not reachable here.

GET/v1/collections/{shareId}

Explorer+

  • stringHeader

    Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    10-character public share id

    Akzeptiert
    letters and digits
    Beispiel

application/json

  • object

    The response payload.

  • string

    Internal id of the collection. Not a credential; the share id is.

  • string

    Display name, as the maker writes it.

  • string | null

    Prose summary of the record, where one has been written.

  • string

    The 10-character public share id, echoing the path parameter.

  • integer

    How many firearms the collection holds.

  • string

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

  • FirearmListItem[]

    The rows this response carries.

  • string

    URL-safe slug identifying the firearm, e.g. glock-17-gen5. Stable: it is what a mirror keys on.

  • string

    Display name, as the maker writes it.

  • string

    Slug of the manufacturer that makes it. Resolve against /v1/manufacturers/{id}.

  • string

    Slug of the category it belongs to. Resolve against /v1/categories.

  • integer | null

    Year it entered production or service. Null where the date is disputed or unknown.

  • FirearmStatus | null

    Production status, one of in_production, discontinued, out_of_production, in_service, limited_production, prototype. Discontinued records are kept deliberately: a rifle built in 2004 wears parts nobody sells today.

  • string | null

    ISO 3166-1 alpha-2 code of where it was designed, e.g. AT.

  • string | null

    How the action cycles: short_recoil, gas_operated, blowback, bolt_action and so on. An open vocabulary: the values in use are published on the schema as x-gunspec-vocabulary, and GET /v1/firearms/action-types is the live list.

  • number | null

    Unloaded weight in grams, without magazine.

  • number | null

    Barrel length in millimetres, measured from the breech face.

  • InlineMediaItem[]

    Every image this firearm has, silhouette first. Empty when none are on file.

  • string

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

  • 400VALIDATION_ERRORValidation error
  • 404NOT_FOUNDResource not found
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

No API key required.

Only collections with visibility: public are resolvable. Private collections return 404.

Items are returned in curator order (sort_order ascending).

Collections are created and edited from the GunSpec dashboard, not via the API.

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.