Skip to content
CRATON Docs Get a free API key

Schema

The published schema

The canonical risk object, the documents every verb answers with, and the map from response to schema. No account, no key, no install.

FileWhat it isEmitted version
risk-object.v0.schema.jsonCraton canonical risk object, v00.2.0
account.v0.schema.jsonCraton account, v00.2.0
accumulation.v0.schema.jsonCraton accumulation rollup, v00.1.0
analysis.v0.schema.jsonCraton analyse run, v00.1.0
backtest-response.v0.schema.jsonCraton backtest artifact, v00.3.0
error.v0.schema.jsonCraton error response, v00.1.0
event-catalogue.v0.schema.jsonCraton public event catalog page, v00.1.0
event-footprint.v0.schema.jsonCraton event footprint, v00.1.0
exchange-check.v0.schema.jsonCraton model exchange connectivity check, v00.1.0
exchange-connector.v0.schema.jsonCraton model exchange connector, v00.1.0
exchange-grants.v0.schema.jsonCraton model exchange grants, v00.1.0
exchange-model-index.v0.schema.jsonCraton model exchange index, v00.1.0
exchange-model.v0.schema.jsonCraton model exchange listing, v00.2.0
exposure-codes.v0.schema.jsonCraton exposure coding answer, v00.1.0
feed-data.v0.schema.jsonCraton feed data document, v00.1.0
feed-index.v0.schema.jsonCraton feed registry index, v00.1.0
feed-object.v0.schema.jsonCraton feed object, v00.1.0
geocode.v0.schema.jsonCraton geocoding lookup, v00.1.0
hazard.v0.schema.jsonCraton point hazard lookup, v00.1.0
job.v0.schema.jsonCraton job resource, v00.4.0
model-object.v0.schema.jsonCraton model object, v00.3.0
model-primitives.v0.schema.jsonCraton model builder primitives, v00.1.0
model-run.v0.schema.jsonCraton model run result, v00.1.0
monitoring-index.v0.schema.jsonCraton monitoring index, v00.1.0
monitoring-notification.v0.schema.jsonCraton monitoring notification, v00.1.0
monitoring-webhook-index.v0.schema.jsonCraton monitoring webhook index, v00.1.0
monitoring-webhook.v0.schema.jsonCraton monitoring webhook registration, v00.1.0
monitoring.v0.schema.jsonCraton monitoring record, v00.1.0
multi-building-flags.v0.schema.jsonCraton multi-building check answer, v00.1.0
package.v0.schema.jsonCraton submission pack, v00.2.0
price-response.v0.schema.jsonCraton price response, v00.1.0
service-info.v0.schema.jsonCraton service info, v00.2.0
structure.v0.schema.jsonCraton structure resource, v00.1.0
usage.v0.schema.jsonCraton usage, v00.1.0
api-contract.v0.jsonCraton API response contract, v0None
README.mdThe Craton canonical risk object schemaNone
validate.pyValidator for the CEDE canonical risk object schema (SPEC.md section 2).None
Versions and validation

The file name carries the version line: risk-object.v0 reads every 0.x.y document, so a minor version never invalidates an object you already hold.

/schema.json is the short URL for the risk object. validate.py validates a document against it with nothing but a Python 3 and this directory.

These are the same files Craton validates its own responses against, served byte for byte as the release carries them.