JSON Ledger API references

You can use openapi.yaml and asyncapi.yaml files that describe the JSON Ledger API and the streaming API, respectively.

Location of JSON Ledger API files

If you have a running instance of Canton with JSON Ledger API enabled, you can download definitions using links:

  • http://<host>:<port>/docs/openapi

  • http://<host>:<port>/docs/asyncapi

where <host> and <port> are the host and port of your Canton instance. Check configuration.

For a general introduction to the JSON Ledger API , see the following sections JSON Ledger API Service V2.

Daml values

Some fields (for instance createArguments in CreateCommand) do not specify any type.

This means the actual type is determined by the Daml model. See Daml type conversion for more details.