Contract status badge
The latest run's verdict as an SVG badge, for a README or a directory listing: green with the number of checks that passed, red with the number that failed, or grey when nothing has been run. Drawn by this API from the same record GET /v1/contract serves, so the badge and the page cannot disagree. Cached for five minutes.
- stringheader
Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields.
Authorization: Bearer <key>is accepted in its place.
- string
Which product or data suite to report:
apifor this REST API,mcpfor the hosted MCP server,fitmentfor the attachment compatibility suite,cataloguefor the catalogue record checks: every file against its schema, no company under two ids, and no firearm whose fields cannot all be true,integrityfor the integrity checks: figures, prose and feature lists copied between unrelated guns, citations that are not evidence, timelines, weight against size, and confidence against evidence,plausibilityfor the plausibility checks: a loaded weight against the empty one and its magazine, a gun older than its cartridge, figures in the wrong unit, energy against velocity, variants that disagree with their family, and the same gun filed twice,anomaliesfor the statistical anomaly checks: a figure unusually far from its family's or its cohort's median, and a barrel an unusual share of its gun's length; each a figure to verify, not one shown wrong,cartridgesfor the cartridge checks: energy against bullet and velocity, pressure in MPa against psi, dimensions no case can have, a bullet against the calibre its name states, a cartridge older than its parent, and each load against its cartridge,materialsfor the materials registry: every material's density quoted from a page that still states it, within the range it declares, and every material value the catalogue uses covered, so the mass checks read sourced densities,corroborationfor the corroboration checks: firearm figures compared with a second, independent source (Wikidata),sourcesfor the source checks: how many records cite their own maker or another authority, and which heavily cited sites the source hierarchy cannot yet name,manufacturersfor the manufacturer checks: every manufacturer record held against Wikidata for its website, founding year, country and whether it still trades,linksfor the link checks: every manufacturer website and every cited source asked whether it still answers and is still the page cited.- Accepts
- string
Which environment's run to report. Production unless asked otherwise.
- Accepts
- string
The wording on the grey half. Defaults to
api contractormcp health. Bounded because it is drawn into an image.- Max length
- 40
- Example
- string
Set
0to draw the badge without the mark, for a row of badges that carry their own.- Accepts
- Example
- 400
VALIDATION_ERROR - 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.