---
updatedAt: 2026-07-29T18:39:39.000Z
---

Fetch the complete documentation index at: https://docs.noves.fi/llms.txt. Use this file to discover all available pages before exploring further.

# Get a party's current CC balances

Returns unlocked, locked, and total CC balances by summing the initial values of active Canton Coin contracts.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Canton Data App API",
    "description": "Self-hosted API for the Noves Canton Data App. Each deployment exposes this API from the customer environment; requests are permission-aware and resolved against the connected Canton participant.",
    "version": "v4"
  },
  "paths": {
    "/api/v2/parties/{party}/balances": {
      "get": {
        "tags": [
          "Balances"
        ],
        "summary": "Get a party's current CC balances",
        "description": "Returns unlocked, locked, and total CC balances by summing the initial values of active Canton Coin contracts.",
        "parameters": [
          {
            "name": "party",
            "in": "path",
            "description": "Canton party identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jwt",
            "in": "header",
            "description": "Ledger API JWT used to read the party's live contracts.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jwt",
            "in": "query",
            "description": "Ledger API JWT alternative to the jwt header.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "description": "Configured validator-node identifier. Defaults to the deployment's default node.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "header",
            "description": "Configured validator-node identifier; the query value takes precedence.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.BalanceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service is still starting",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CantonDataApp.Database.StartupStatusResponse"
                    },
                    {
                      "$ref": "#/components/schemas/CantonDataApp.Api.QuarantinedNodeResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CantonDataApp.Api.ApiErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Api.BalanceResponse": {
        "type": "object",
        "properties": {
          "partyId": {
            "type": "string",
            "nullable": true
          },
          "unlockedBalance": {
            "type": "string",
            "nullable": true
          },
          "lockedBalance": {
            "type": "string",
            "nullable": true
          },
          "totalBalance": {
            "type": "string",
            "nullable": true
          },
          "source": {
            "type": "string",
            "nullable": true
          },
          "unlockedContractCount": {
            "type": "integer",
            "format": "int32"
          },
          "lockedContractCount": {
            "type": "integer",
            "format": "int32"
          },
          "totalContractCount": {
            "type": "integer",
            "format": "int32"
          },
          "asOf": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Api.QuarantinedNodeResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true
          },
          "nodeId": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "network": {
            "type": "string",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.ReplayNodeStatus": {
        "type": "object",
        "properties": {
          "nodeId": {
            "type": "string",
            "nullable": true
          },
          "currentOffset": {
            "type": "integer",
            "format": "int64"
          },
          "targetOffset": {
            "type": "integer",
            "format": "int64"
          },
          "status": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.StartupReplayResponse": {
        "type": "object",
        "properties": {
          "nodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CantonDataApp.Database.ReplayNodeStatus"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.StartupStatusResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "nullable": true
          },
          "phase": {
            "type": "string",
            "nullable": true
          },
          "phaseNumber": {
            "type": "integer",
            "format": "int32"
          },
          "totalPhases": {
            "type": "integer",
            "format": "int32"
          },
          "startedAt": {
            "type": "string",
            "nullable": true
          },
          "elapsedSeconds": {
            "type": "integer",
            "format": "int32"
          },
          "error": {
            "type": "string",
            "nullable": true
          },
          "schemaVersion": {
            "type": "string",
            "nullable": true
          },
          "targetSchemaVersion": {
            "type": "string",
            "nullable": true
          },
          "bootstrapSource": {
            "type": "string",
            "nullable": true
          },
          "bootstrapVersion": {
            "type": "string",
            "nullable": true
          },
          "pendingMigrations": {
            "type": "integer",
            "format": "int32"
          },
          "lastMigrationDurationMs": {
            "type": "integer",
            "format": "int64",
            "nullable": true
          },
          "dataMigrations": {
            "type": "array",
            "items": {},
            "nullable": true
          },
          "replay": {
            "$ref": "#/components/schemas/CantonDataApp.Database.StartupReplayResponse"
          }
        },
        "additionalProperties": false
      },
      "Microsoft.AspNetCore.Mvc.ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      }
    }
  },
  "tags": [
    {
      "name": "Balances"
    }
  ]
}
```