Splice APIs

Reference documentation for the Scan, Validator, SV, and Daml APIs that run on Canton Network nodes.

Splice nodes expose REST APIs that are separate from the Ledger API and the Admin API. These APIs are served by the Splice application layer running on top of Canton and provide access to Canton Network-specific functionality: querying network state, managing wallets, operating validators, and governing the network as a Super Validator (SV).

Sub-pages

• Splice APIs Overview — entry point and how the APIs fit together
• Splice HTTP APIs — the HTTP/REST APIs at a glance
• Splice Daml APIs — Daml choice-based APIs exposed by the Splice DARs
• Splice Daml Models — the Daml model packages shipped with Splice

Scan APIs (read-only, public)

• Scan APIs — introduction and scan endpoint surface
• Scan Aggregates API
• Scan Bulk Data API
• Scan Canton Coin Reference Data API
• Scan API for Current State of CC and Synchronizer Traffic
• Scan Global Synchronizer Connectivity API
• Scan Global Synchronizer Operations API
• Scan Open API Reference

Validator-side APIs

• Validator APIs — wallet, user management, external signing, and validator administration

Authentication

All Splice APIs except the public Scan API require a JWT token passed as an OAuth2 Bearer token:

Authorization: Bearer <your-token>

The Scan API is publicly accessible and does not require authentication.

OpenAPI Specifications

The full set of OpenAPI specifications is published in the Splice repository:

• scan.yaml — Scan API
• wallet-external.yaml — Wallet API (external)
• ans-external.yaml — ANS API (external)
• validator-internal.yaml — Validator API (internal)
• sv-internal.yaml — SV API (internal)
• scan-proxy.yaml — Scan Proxy API

Endpoints in files named *-external carry backwards compatibility guarantees. Endpoints in *-internal files may change between releases without notice.

Related Pages

• Ledger API — gRPC API for submitting commands and reading the transaction stream
• Admin API — Canton node administration
• JSON API — HTTP/REST wrapper for the Ledger API