Skip to main content

How it is versioned

  • The API version goes in the path: today it is v1, and GET /health reports it in api_version.
  • Additive changes do not change the version: a new field in a response, an optional parameter or a new endpoint. Your client should ignore fields it does not know.
  • A contract change (removing or renaming a field, or changing what it means) is announced here with its date and what to do.
  • The methodology (the rules behind every claim) has its own version: GET /v1/methodology returns version and fingerprint. The fingerprint changes when any threshold changes, even if the code does not.
Sealed evidence packages record the methodology version they were built with, so an old report can be reproduced and verified with the rules of its time.

Recent changes

Smart contract audit
New GET /v1/audit, GET /v1/audit/{id} and GET /v1/audit/{id}/{section}, free of charge. An audit is visible only to its organization. While the audit engine is not available, they return synthetic audits marked demo: true.
Enterprise quota
On the enterprise plan, everything the organization spends counts against its quota and stops when it runs out, including organization keys and keys of members on another plan. X-Credits-* and GET /v1/account show the account with the lowest balance, and credits.shared says whether it is the organization’s.
Read-only roles, organization keys and cost caps
  • viewer role and organization keys with scopes and read_only. Anything not allowed returns 403 with error: "read_only" or error: "key_scope".
  • Contract change: enterprise is no longer unlimited. Its monthly quota is the organization’s (5,000,000 credits by default) and X-Credits-Limit is always a number.
  • A cap on reads from the data sources per query (4,000 by default). Past the cap, reason: "budget_exhausted".
Failure causes
The 503 source_unavailable adds source_fault and failure_cause (additive).
Guard
New /v1/guard/* endpoints to watch addresses and work their alerts, free of charge. They require a key assigned to a person.