client.features.listIcons()
List the drawn feature icons, a page at a time. On every plan.
listIcons(params?: ListFeatureIconsParams): Promise<PaginatedResponse<FeatureIcon>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- string
Part of an icon's name; spaces and hyphens read as underscores, so
picatinny railfindspicatinny_rail- Example
- integerdefault
1Page number, from 1 to 10,000
- Range
- 1 – 10000
- Example
- integerdefault
20Items per page (max 100)
- Range
- 1 – 100
- Example
- FeatureIcon[]
One page of results
- string
The icon's file name without extension, e.g.
5r_rifling. Stable across releases. - string
The name as a reader would write it, e.g.
5R Rifling. - string
The drawing on the assets CDN, a WebP image. Public: it needs no key to fetch.
- number
Current page number
- number
Items per page
- number
Total matching records (Builder and above)
- 400
VALIDATION_ERROR - 401
UNAUTHORIZED - 403
FORBIDDEN - 429
RATE_LIMITED - 500
INTERNAL_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.