LEARN · DOCUMENTATION
Documentation
Pages from 29 sources, kept in sync: the official Canton Network and Digital Asset docs, documentation from teams building on Canton, and readmes from their code. Search all of it, or start from a path below.
3,253pages
synced 5h ago29 sources
Official
POST /v2/dars
cURL curl --request POST \ --url 'http://localhost:7575/v2/dars' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/octet-stream' \ --data-binary '@request.bin' 200 400 default {} <string> { "code": "<string>", "cause": "<
Aug 31, 2026
Official
POST /v2/parties/external/generate-topology
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/parties/external/generate-topology' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "synchronizer": "<string>", "partyHint": "<strin
Aug 31, 2026
Official
GET /v2/state/ledger-end
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/state/ledger-end' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/state/ledger-end" headers = {'Authorization': 'Bearer <token>
Aug 31, 2026
Official
GET /v2/updates/transaction-tree-by-id/:update-id
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/updates/transaction-tree-by-id/{update-id}' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/updates/transaction-tree-by-id/{upd
Aug 31, 2026
Official
GET /v2/users/:user-id/rights
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/users/{user-id}/rights' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/users/{user-id}/rights" headers = {'Authorization': 'Be
Aug 31, 2026
Official
PATCH /v2/users/:user-id
cURL Python JavaScript PHP Go Java Ruby curl --request PATCH \ --url 'http://localhost:7575/v2/users/{user-id}' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "user": { "id": "<string>", "primaryParty": "<string>",
Aug 31, 2026
Official
POST /v2/commands/async/submit-reassignment
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/commands/async/submit-reassignment' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "reassignmentCommands": { "workflowId": "<stri
Aug 31, 2026
Official
POST /v2/commands/submit-and-wait-for-transaction
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/commands/submit-and-wait-for-transaction' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "commands": { "commands": [ {
Aug 31, 2026
Official
GET /v2/parties/:party
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/parties/{party}' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/parties/{party}" headers = {'Authorization': 'Bearer <token>'}
Aug 31, 2026
Official
GET /v2/updates/transaction-tree-by-offset/:offset
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/updates/transaction-tree-by-offset/{offset}' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/updates/transaction-tree-by-offset
Aug 31, 2026
Official
GET /v2/version
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/version' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/version" headers = {'Authorization': 'Bearer <token>'} response = requ
Aug 31, 2026
Official
POST /v2/commands/completions
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/commands/completions' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "userId": "<string>", "parties": [ "<string>" ], "begi
Aug 31, 2026
Official
POST /v2/state/active-contracts-page
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/state/active-contracts-page' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "activeAtOffset": 123, "eventFormat": { "filtersByP
Aug 31, 2026
Official
POST /v2/updates/flats
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/flats' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "beginExclusive": 123, "endInclusive": 123, "filter": { "filter
Aug 31, 2026
Official
GET /v2/parties
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/parties' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/parties" headers = {'Authorization': 'Bearer <token>'} response = requ
Aug 31, 2026
Official
GET /v2/users
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'http://localhost:7575/v2/users' \ --header 'Authorization: Bearer $TOKEN' import json import requests url = "http://localhost:7575/v2/users" headers = {'Authorization': 'Bearer <token>'} response = requests
Aug 31, 2026
Official
PATCH /v2/idps/:idp-id
cURL Python JavaScript PHP Go Java Ruby curl --request PATCH \ --url 'http://localhost:7575/v2/idps/{idp-id}' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "identityProviderConfig": { "identityProviderId": "<string>",
Aug 31, 2026
Official
POST /v2/commands/submit-and-wait
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/commands/submit-and-wait' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "commands": [ { "CreateAndExerciseCommand": {
Aug 31, 2026
Official
POST /v2/contracts/contract-by-id
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/contracts/contract-by-id' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "contractId": "<string>", "queryingParties": [ "<strin
Aug 31, 2026
Official
POST /v2/interactive-submission/prepare
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/interactive-submission/prepare' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "userId": "<string>", "commandId": "<string>", "co
Aug 31, 2026
Official
POST /v2/updates/transaction-by-offset
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/transaction-by-offset' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "offset": 123, "requestingParties": [ "<string>"
Aug 31, 2026
Official
POST /v2/updates/trees
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/trees' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "beginExclusive": 123, "endInclusive": 123, "filter": { "filter
Aug 31, 2026
Official
POST /v2/updates/transaction-by-id
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/transaction-by-id' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "updateId": "<string>", "requestingParties": [ "<stri
Aug 31, 2026
Official
POST /v2/users
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/users' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "user": { "id": "<string>", "primaryParty": "<string>", "isDeactiva
Aug 31, 2026
Official
POST /v2/users/:user-id/rights
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/users/{user-id}/rights' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "userId": "<string>", "rights": [ { "kind": {
Aug 31, 2026
Official
POST /v2/updates/update-by-id
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/update-by-id' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "updateId": "<string>", "updateFormat": { "includeTransact
Aug 31, 2026
Official
POST /v2/updates/update-by-offset
cURL Python JavaScript PHP Go Java Ruby curl --request POST \ --url 'http://localhost:7575/v2/updates/update-by-offset' \ --header 'Authorization: Bearer $TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "offset": 123, "updateFormat": { "includeTransactions"
Aug 31, 2026
Official
GET /v0/domains/:domain_id/parties/:party_id/participant-id
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/parties/{party_id}/participant-id' import json import requests url = "https://scan.sv-1.global.canton.network.sync.global/ap
Aug 31, 2026
Official
GET /v0/amulet-config-for-round
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/amulet-config-for-round' import json import requests url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/amulet-config-for-ro
Aug 31, 2026
Official
GET /v0/domains/:domain_id/members/:member_id/traffic-status
cURL Python JavaScript PHP Go Java Ruby curl --request GET \ --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/domains/{domain_id}/members/{member_id}/traffic-status' import json import requests url = "https://scan.sv-1.global.canton.network.sync.global/a
Aug 31, 2026
Showing 1,021 to 1,050 of 1,473Search all sources →