Content

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

20

Filter by entry category

Akzeptiert

featureimprovementbugfixdatabreaking

Max. Länge

60

One page of results

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

Integer flag, 1 when the entry is live. The public feed only returns published entries, so this is 1 on every row a consumer sees.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Changelog entry id

Beispiel

039-3d-models-line-art-and-a-phantom-firearm

The response payload

Slug of the entry, taken from the file it was authored in.

Entry headline.

Entry body, in Markdown.

What kind of change: feature, improvement, bugfix, data, breaking.

When it was published, ISO 8601.

Integer flag, 1 when the entry is live. The public feed only returns published entries, so this is 1 on every row a consumer sees.

When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

When it last changed, ISO 8601.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Updates per page

Bereich

1 – 50

Beispiel

20

Filter by what the post is about

Akzeptiert

catalogplatformpolicycompanyincident

A dated post about the service: what is happening with the catalogue, the platform or the company, and why. Distinct from /v1/changelog, which records what shipped, and from a site notice, which is one line of chrome.

The slug, and the URL: gunspec.io/updates/{id}.

The headline, as the post is listed.

One or two sentences under the headline, for a list or a feed.

What a site update is about: the catalogue, the platform, a policy, the company, or an incident.

The post, as typed blocks in reading order rather than markup: see UpdateBlock.

The kind of block in a site update body. Each maps to a renderer on the website.

The words, on a paragraph, heading or quote.

The entries of a list.

Whether a list is numbered.

Who a quote is from.

The source of a code block.

How to highlight a code block.

The figure beside an update. Either a picture, or a character-field pattern the website draws itself: most posts have no photograph, and a named drawing is the honest alternative to a stock image. Read kind to tell them apart.

The line under a figure.

The figure beside an update. Either a picture, or a character-field pattern the website draws itself: most posts have no photograph, and a named drawing is the honest alternative to a stock image. Read kind to tell them apart.

What the asset is: silhouette, render, photo, schematic, model. /v1/firearms/{id}/media/{selector} addresses an asset by this.

Where the picture is. Present when kind is image.

What the picture shows. Present when kind is image.

A character-field pattern an update may name in place of a photograph. The website draws it.

Seeds the drawing. The same seed always draws the same field, so a post keeps its figure between loads.

What the words pattern spells. Ignored by the others.

The day the post is dated, as YYYY-MM-DD. A later edit does not re-date it.

Held at the top of the list regardless of date.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The update slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

faster-corrections-and-published-data-checks

The response payload.

A dated post about the service: what is happening with the catalogue, the platform or the company, and why. Distinct from /v1/changelog, which records what shipped, and from a site notice, which is one line of chrome.

The slug, and the URL: gunspec.io/updates/{id}.

The headline, as the post is listed.

One or two sentences under the headline, for a list or a feed.

What a site update is about: the catalogue, the platform, a policy, the company, or an incident.

The post, as typed blocks in reading order rather than markup: see UpdateBlock.

The figure beside an update. Either a picture, or a character-field pattern the website draws itself: most posts have no photograph, and a named drawing is the honest alternative to a stock image. Read kind to tell them apart.

The day the post is dated, as YYYY-MM-DD. A later edit does not re-date it.

Held at the top of the list regardless of date.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

Published notices inside their display window, best first: highest priority, then newest.

Row id of the notice. The website keys its dismissal on this, so a new notice is seen even by a reader who dismissed the last one.

Short label shown before the message.

The sentence shown in the banner.

A second line, shown under the highlight where one is set.

How prominently a site notice is shown.

Text of the call to action, or null when the banner has none.

Where the call to action goes.

Higher sorts first. Ties break on newest.

When the notice becomes visible. Null means immediately.

When it stops being shown. This is why notices are rows rather than copy: an end date is the only version of "take this down later" that does not rely on somebody remembering.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

The latest run per language, ordered by language.

Which promise the run is about: sdk for the published packages, api for the cURL commands the reference prints.

The sample's own language. On an SDK run, typescript or python for the published package. On an API run, the tab of the reference it came from: curl, javascript (the TypeScript tab's generated fetch), python (its generated requests), or unity, unreal and godot, which are checked rather than executed.

How the run arrived at its results. executed ran the sample against this API. static could not, and checked the sample against the operation it documents instead: the Unity, Unreal and GDScript samples are fragments meant for a class, an actor or a scene, so running one would mean wrapping it in code the reference does not print.

What was exercised: the release installed from the registry on an SDK run, and the spec version the samples were generated from on an API run. The release rather than the version in our tree, because the badge vouches for what a reader gets today.

The API the run was executed against. Production, so the badge vouches for the live service rather than a preview.

When the run finished, ISO 8601.

The commit of this repository the run was started from, or null where CI did not report one.

The CI run, so the claim can be checked rather than taken.

Examples that ran and returned what the page prints.

Examples that ran and did not. A non-zero count is what takes the badge down.

Write examples, which are never run against production: each would create a real ticket, webhook endpoint or seller offer.

Examples this SDK has no method for. The reference shows no sample for them either.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Narrow to one surface: sdk for the SDK references, api for the reference samples, mcp for the hosted MCP server's tools. Omitted returns every surface.

Akzeptiert

sdkapimcp

Beispiel

api

samples adds sample to each example: what it answered when the run executed it, trimmed for display. Only the MCP surface stores answers today; every example says whether it has one in hasSample either way.

Akzeptiert

samples

The response payload.

The latest run per surface and language, ordered by surface then language.

Which promise the run is about: sdk for the published packages, api for the cURL commands the reference prints.

The sample's own language. On an SDK run, typescript or python for the published package. On an API run, the tab of the reference it came from: curl, javascript (the TypeScript tab's generated fetch), python (its generated requests), or unity, unreal and godot, which are checked rather than executed.

How the run arrived at its results. executed ran the sample against this API. static could not, and checked the sample against the operation it documents instead: the Unity, Unreal and GDScript samples are fragments meant for a class, an actor or a scene, so running one would mean wrapping it in code the reference does not print.

What was exercised: the release installed from the registry on an SDK run, and the spec version the samples were generated from on an API run. The release rather than the version in our tree, because the badge vouches for what a reader gets today.

The API the run was executed against. Production, so the badge vouches for the live service rather than a preview.

When the run finished, ISO 8601.

The commit of this repository the run was started from, or null where CI did not report one.

The CI run, so the claim can be checked rather than taken.

Examples that ran and returned what the page prints.

Examples that ran and did not. A non-zero count is what takes the badge down.

Write examples, which are never run against production: each would create a real ticket, webhook endpoint or seller offer.

Examples this SDK has no method for. The reference shows no sample for them either.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Which product or data suite to report: api for this REST API, mcp for the hosted MCP server, fitment for the attachment compatibility suite, catalogue for the catalogue record checks: every file against its schema, no company under two ids, and no firearm whose fields cannot all be true, integrity for 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, plausibility for 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, anomalies for 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, cartridges for 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, materials for 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, corroboration for the corroboration checks: firearm figures compared with a second, independent source (Wikidata), sources for the source checks: how many records cite their own maker or another authority, and which heavily cited sites the source hierarchy cannot yet name, manufacturers for the manufacturer checks: every manufacturer record held against Wikidata for its website, founding year, country and whether it still trades, links for the link checks: every manufacturer website and every cited source asked whether it still answers and is still the page cited.

Akzeptiert

apimcpfitmentcatalogueintegrityplausibilityanomaliescartridgesmaterialscorroborationsourcesmanufacturerslinks

Which environment's run to report. Production unless asked otherwise.

Akzeptiert

productionstaginglocal

The wording on the grey half. Defaults to api contract or mcp health. Bounded because it is drawn into an image.

Max. Länge

40

Beispiel

gunspec mcp

Set 0 to draw the badge without the mark, for a row of badges that carry their own.

Akzeptiert

01

Beispiel

0

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The check id, as the run lists it under systemChecks.

Beispiel

firearm-singleshot-capacity

Which product or data suite the run measured: api for this REST API, mcp for the hosted MCP server, fitment for the attachment compatibility suite, catalogue for the catalogue record checks: every file against its schema, no company under two ids, and no firearm whose fields cannot all be true, integrity for 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, plausibility for 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, anomalies for 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, cartridges for 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, materials for 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, corroboration for the corroboration checks: firearm figures compared with a second, independent source (Wikidata), sources for the source checks: how many records cite their own maker or another authority, and which heavily cited sites the source hierarchy cannot yet name, manufacturers for the manufacturer checks: every manufacturer record held against Wikidata for its website, founding year, country and whether it still trades, links for the link checks: every manufacturer website and every cited source asked whether it still answers and is still the page cited. Defaults to api.

Akzeptiert

apimcpfitmentcatalogueintegrityplausibilityanomaliescartridgesmaterialscorroborationsourcesmanufacturerslinks

Beispiel

catalogue

Which environment to report. Production unless asked otherwise.

Akzeptiert

productionstaginglocal

Beispiel

production

The page, from 1.

Minimum

1

Beispiel

1

Findings per page.

Bereich

1 – 1000

Beispiel

100

The response payload.

The check.

When the run started.

How many the check found in all.

How many findings the run published; the rest were not stored.

This page.

Findings per page.

How many pages there are.

The findings on this page, one line each, the record first.

Beside each item, where the record's data task for this check has got to, or null when it has none.

Queued for the data agent, being worked, proposed and waiting on a person, or accepted and on its way into the catalogue.

Research a value from a source, or review a judgement.

How many tasks the record has for this check; a research task is one per field.

The agent working it, while it is worked or proposed.

Each task behind the mark, most active first. Load one at /v1/data/tasks/{number}.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Which environment to report. Production unless asked otherwise; a staging run is never mixed into it.

Akzeptiert

productionstaginglocal

Beispiel

production

Which product or data suite the run measured: api for this REST API, mcp for the hosted MCP server, fitment for the attachment compatibility suite, catalogue for the catalogue record checks: every file against its schema, no company under two ids, and no firearm whose fields cannot all be true, integrity for 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, plausibility for 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, anomalies for 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, cartridges for 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, materials for 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, corroboration for the corroboration checks: firearm figures compared with a second, independent source (Wikidata), sources for the source checks: how many records cite their own maker or another authority, and which heavily cited sites the source hierarchy cannot yet name, manufacturers for the manufacturer checks: every manufacturer record held against Wikidata for its website, founding year, country and whether it still trades, links for the link checks: every manufacturer website and every cited source asked whether it still answers and is still the page cited. Defaults to api.

Akzeptiert

apimcpfitmentcatalogueintegrityplausibilityanomaliescartridgesmaterialscorroborationsourcesmanufacturerslinks

Beispiel

api

The response payload.

The latest run, or null when nothing has been checked on this environment yet.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The operation's path: a documented template, a concrete path or a full URL. A path that names no operation is matched as a prefix.

Max. Länge

300

Beispiel

/v1/firearms/{id}

Narrow to one HTTP method. Omitted returns every method the path answers.

Akzeptiert

GETPOSTPUTPATCHDELETE

Beispiel

GET

The response payload.

exact when the path named an operation, prefix when it did not and these are the operations under it (at most 25).

The version of this document the reference was rendered from.

The matching operations.

HTTP method.

The documented path template.

The operation's title in the reference.

What the operation does, as the reference states it.

The lowest plan that may call it: public, account (a key attached to a user account), explorer, builder, studio or enterprise.

Whether a key is required, optional or not used (none).

Whether it answers 304 Not Modified to an If-None-Match carrying the ETag it sent.

The operation's page in the reference.

Path, query and header parameters, as the reference lists them.

The request body, or null for an operation that takes none.

What success looks like.

Every failure the operation documents.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The operation's path: a documented template, a concrete path or a full URL.

Max. Länge

300

Beispiel

/v1/firearms

The HTTP method. Needed only when the path answers more than one.

Akzeptiert

GETPOSTPUTPATCHDELETE

Beispiel

GET

curl, javascript (TypeScript with fetch), python (requests), unity, unreal, godot, or sdk-typescript / sdk-python for the SDKs.

Akzeptiert

curljavascriptpythonunityunrealgodotsdk-typescriptsdk-python

Beispiel

python

The response payload.

HTTP method of the operation.

Its documented path template.

The lowest plan that may call it.

The operation's page in the reference.

The language asked for.

How to fill in the key placeholder, or null for an operation that takes no key.

One sample, or one per SDK method for an operation more than one method calls.

What the sample is: the tab name, or the SDK call.

The sample, exactly as the reference prints it.

The last run that checked this sample, or null when none has.

Anything to know before using it, such as why it is not executed, or null.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

Every plan, cheapest first.

Plan id.

Plan name.

Monthly price in US cents.

Requests allowed per minute, per key.

Requests allowed per day, per key.

Requests included per month.

Calls through the hosted MCP server allowed per day, inside the daily request allowance.

The deepest page a list may be read to, or null for no limit.

Whether paginated responses include the total count.

Limits on a caller that sends no key.

Requests allowed per day to the endpoints that need no key.

The deepest page a list may be read to without a key.

How fast a list may be paged through before PAGINATION_BURST is returned.

Pages that may be read in quick succession.

The window those pages are counted over.

How long to wait after a 429.

The Retry-After sent with a per-minute refusal.

The longest Retry-After a daily refusal sends. The value sent is the seconds left until the next midnight UTC, when the counters return to zero, so it is never more than this.

The headers a key may be sent in.

The rate limits page in the docs.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The response payload.

How many guides there are.

Every guide, in the order the documentation lists them.

The guide's id, passed to the read endpoint.

The page's title.

The page a reader would open.

The opening prose: what the page is about.

The whole page in Markdown, so a caller can tell what reading it costs.

Every heading on the page, in order.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The question, in the words it would be asked in.

Max. Länge

200

Beispiel

how do I handle a 429

How many sections to return.

Bereich

1 – 25

Beispiel

8

The response payload.

The question as it was asked.

How many sections matched, of which results carries the best.

The matching sections, best first.

The guide the section is on.

That guide's title.

The section's anchor.

The heading.

The heading with the ones above it.

The page, opened at that heading.

The opening of the section, so a caller can judge it without reading it.

Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

The guide's id, as the list endpoint gives it.

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

caching

Return only the section this heading anchor names. Omitted, the whole page comes back.

Max. Länge

120

Beispiel

caching-policy

The response payload.

The guide's id.

The page's title.

The page, opened at the section when one was named.

The opening prose. Sent with a whole page only.

The whole page as Markdown. Sent when no anchor was given.

The page's headings, or the named section - one anchor can hold several headings where a page deep-links only the outer one.

The heading's anchor.

The heading.

The heading with the ones above it.

The section's prose. Sent when an anchor was given.

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Page number, from 1 to 10,000

Bereich

1 – 10000

Beispiel

1

Items per page (max 100)

Bereich

1 – 100

Beispiel

20

Filter by post category

Max. Länge

60

Beispiel

guides

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

What the hero image shows, as alt text. Null where the post has no hero or none was written.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.

Who wrote the post: the display name on the account that created it, never its address. Null when that account has no display name, and the post is then attributed to the publisher.

The author's display name, as set on their GunSpec account.

URL segment of the author's page on the blog, made from their display name.

Which avatar style the author chose on their account.

Seed the avatar is drawn from. Stable per author, and not their account id.

Current page number

Items per page

Total matching records (Builder and above)

Optional. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei. Authorization: Bearer <key> wird ebenfalls akzeptiert.

Blog post slug

Akzeptiert

a lowercase slug: letters, digits and hyphens

Beispiel

complete-guide-firearm-calibers-for-developers

The response payload.

A published post. Both endpoints serve the stored row; body is markdown.

Opaque post id. A string, not a number: posts are keyed like every other authored record here.

URL-safe slug, and what /v1/blog/{slug} addresses.

Post headline.

One-line description, for a card or a feed. Null where the author wrote none.

The post itself, as markdown.

Path of the hero image on the assets CDN, or null. Prefix it with the assets host to fetch.

What the hero image shows, as alt text. Null where the post has no hero or none was written.

Editorial category, e.g. guides. Null where the post has none.

Always published on these endpoints: a draft is not served publicly.

When the post was published, which is what the list orders by. Null on a post never given a date.

When the post was first written, YYYY-MM-DD HH:MM:SS in UTC. Not the publication date: postedAt is.

When the post was last edited, YYYY-MM-DD HH:MM:SS in UTC.