client.platforms.get()
A platform's interface rows and members. Answers 304.
get(id: string): Promise<APIResponse<PlatformDetail>>- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- stringrequired
Platform slug
- Accepts
- a lowercase slug: letters, digits and hyphens
- Example
- object
The response payload.
- string
Slug of the platform.
- string
Display name, as the maker writes it.
- string | null
Prose summary of the record, where one has been written.
- object[]
The mount interfaces resolved for this firearm, own rows first, then inherited.
- string
Where on the firearm the interface sits:
muzzle,rear,top,bottom. - string
Id of the interface standard, kind-prefixed, e.g.
thread:1/2x28. Ids are never renamed; new spellings become aliases. - string
Display name, as the maker writes it.
- string
What the asset is:
silhouette,render,photo,schematic,model./v1/firearms/{id}/media/{selector}addresses an asset by this. - number
How well evidenced this row is, 0 to 1. A minimum, not an average: an inferred row caps every fit computed through it, and
min_confidenceon the endpoint hides rows below a threshold. - string | null
Free-text notes that do not belong in a specific field.
- object[]
The firearms belonging to this platform, which inherit its default interfaces.
- string
Slug of the firearm.
- string
Display name, as the maker writes it.
- 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
- Studio+
- Monthly quota
- 150,000/mo
- Rate limit
- 120/min
- Daily cap
- 10,000
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.
This read answers conditional requests. Keep the ETag from a response and send it back as If-None-Match: an unchanged record returns 304 Not Modified with no body, which counts toward your per-minute rate limit but not your daily allowance.