---
title: "Index every firearm that has imagery"
method: GET
path: "/v1/firearms/media"
tags: ["Firearms"]
---

# Index every firearm that has imagery

`GET /v1/firearms/media`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/firearms/media`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns each firearm with a render or photograph, and that imagery, as a three-field row. Built for media grids and mirroring jobs: paging the full catalogue with `has_image=true` returns fifteen fields per row, twelve of which such a caller discards. Silhouettes are excluded; every firearm has one. `per_page` allows up to 1000 here for the same reason.

Every response carries `meta.fingerprint`, which changes when imagery is added or removed. A client holding a cached copy of this collection can request a single row and compare it, rather than downloading the collection to discover whether it changed.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

## Query parameters

- `page` integer
- `per_page` integer
- `kind` 'silhouette' | 'render' | 'photo' | 'schematic' | 'model'
- `ids` string

## Headers

- `If-None-Match` string

## Response `200`

Index every firearm that has imagery

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` MediaCatalogEntry[], required: One page of results. Use `pagination` to walk the rest.
    - `id` string, required: Slug of the firearm this row is about.
    - `name` string, required: Display name, as the maker writes it.
    - `images` InlineMediaItem[], required: The imagery on file for it, silhouette excluded, since every firearm has one of those.
      - `id` integer, required: Autoincrementing image id.
      - `url` string, required: Absolute, directly fetchable URL.
      - `kind` 'silhouette' | 'render' | 'photo' | 'schematic' | 'model', required: What kind of asset a media row is.
      - `alt` string, nullable: Alt text, where one has been written. Null otherwise, so do not render an empty string.
      - `width` integer, nullable: Pixel width, where it is known.
      - `height` integer, nullable: Pixel height, where it is known.
  - `pagination` Pagination: Page-size is reported under both `per_page` (matching the request parameter) and `limit` (retained for existing integrations). They always carry the same value. `total` and `totalPages` are omitted for Explorer and anonymous callers.
    - `page` integer, required: The page this response is, 1-based.
    - `per_page` integer, required: Page size. Same value as `limit`.
    - `limit` integer, required: Page size. Alias of `per_page`.
    - `total` integer: Total records matching the query across every page.
    - `totalPages` integer: How many pages the result set spans at the current `per_page`.

## Other responses

- `304`: Your copy is current. No body is sent, and this response does not count toward the daily request allowance.
- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)