---
title: "List feature icons"
method: GET
path: "/v1/features/icons"
tags: ["Firearm Discovery"]
---

# List feature icons

`GET /v1/features/icons`

## Request

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

Every drawn feature icon, for building a legend or an icon set. A firearm's own come as `feature_icon` items in `/v1/firearms/{id}/media`. Each is a WebP on the assets CDN that loads without a key. Needs an API key on every plan, the free one included, and shows the total on every plan.

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

## Query parameters

- `q` string
- `page` integer
- `per_page` integer

## Response `200`

List feature icons

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` FeatureIcon[], required: One page of results. Use `pagination` to walk the rest.
    - `name` string, required: The icon's file name without extension, e.g. `5r_rifling`. Stable across releases.
    - `label` string, required: The name as a reader would write it, e.g. `5R Rifling`.
    - `iconUrl` string, uri, required: The drawing on the assets CDN, a WebP image. Public: it needs no key to fetch.
  - `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

- `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)