Quickstart

Start querying a self-hosted Canton Data App deployment.

1. Confirm your Data App URL

Your Data App API is available at your deployment’s host: ​https://your-data-app-host/

All API endpoints are under /api/v2.

2. Check API health

Use the health endpoint to confirm the API is reachable:

curl"https://your-data-app-host/api/v2/health"

3. List configured nodes

If your deployment has multiple validator nodes configured, you can inspect
the available nodes:

curl "https://your-data-app-host/api/v2/nodes"

4. Query party data

Most party-scoped endpoints require a Canton Ledger API JWT. Pass it with the jwt header:

curl "https://your-data-app-host/api/v2/parties/{party}/balances" -H "jwt: CANTON_LEDGER_API_JWT"

You can also retrieve indexed transactions for a party:

curl "https://your-data-app-host/api/v2/txs/indexed/{party}" -H "jwt: CANTON_LEDGER_API_JWT"

5. Use pagination where available

List endpoints may return paginated results. When a response includes a cursor or next-page value, pass it to the next request according to the endpoint’s parameters.

Notes

  • The API is served by your own Data App deployment, not by Noves Cloud.
  • The base URL is deployment-specific.
  • Access is permission-aware and depends on the caller’s Canton rights.
  • Some data may depend on indexing readiness and the connected participant’s available history.