API Reference

Every public endpoint of the CantonCap API, generated from the OpenAPI contract the API is built from.

CantonCap APIContract 1.0.035 endpointsOpenAPI 3.1

Conventions

Base URL https://api.cantoncap.cc. Every public path starts with /v1 and every public operation is a GET.
Authenticate every request with the X-API-Key header. See Authentication.
Responses are JSON in one envelope: status, data and, on paginated collections, pagination. See Responses.
Prices, amounts and ratios are exact decimal strings. See Decimals and precision.
Errors share one envelope with a typed error.code. See Errors.
The IDs in the examples are illustrative, except Canton Coin's ast_515c3eaa72bd4a8b9403297879d78ef6. Resolve real IDs with GET /v1/assets/map.

The OpenAPI Document

This reference is generated from the OpenAPI 3.1 contract the API itself is built and tested against. Download it to generate a client, import it into Postman or Insomnia, or diff it between releases.

Shell

curl -sO https://docs.cantoncap.cc/openapi.json
curl -sO https://docs.cantoncap.cc/openapi.yaml

Contract

The document served here is the canonical contract, with an operationId on every operation. The interactive explorer at api.cantoncap.cc/docs is generated by the running service and reports an older version number; prefer this file for code generation.