client.firearms.getImages()
Get images for a firearm.
getImages(id: string): Promise<APIResponse<FirearmImage[]>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- stringrequired
Resource slug ID
- Accepts
- a lowercase slug: letters, digits and hyphens
- Example
- FirearmImage[]
The response payload.
- integer
Autoincrementing image id. Numeric, unlike the catalog slugs.
- string
Slug of the firearm this row belongs to.
- string
Absolute, directly fetchable URL.
- ImageType | null
Role of the image:
primary,gallery,thumbnail,svg,render. - string | null
Where the record came from: a curated entry, an inference, or an import.
- string | null
Licence the asset is held under, where one is recorded.
- MediaKind | null
What the asset is:
silhouette,render,photo,schematic,model./v1/firearms/{id}/media/{selector}addresses an asset by this. - string | null
Where the bytes live:
cdnfor a static path,r2for an upload we serve. - string | null
Who made the asset, where it is credited.
- string | null
Page the asset or document was taken from.
- string | null
Alt text, where one has been written. Null otherwise, so do not render an empty string.
- integer | null
Pixel width, where it is known.
- integer | null
Pixel height, where it is known.
- integer
Position within its list, ascending.
- 400
VALIDATION_ERRORValidation error - 401
UNAUTHORIZEDAPI key required - 403
FORBIDDENValid key, not permitted - 404
NOT_FOUNDResource not found - 429
RATE_LIMITEDRate limit exceeded - 500
INTERNAL_ERRORUnexpected server error
- Minimum tier
- Explorer+
- Monthly quota
- 200/mo
- Rate limit
- 10/min
- Daily cap
- 50
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.