Documentation/canton-network-docsView on canton-network-docs ↗
canton-network-docs

/v0/scan

/v0/scan-proxy/holdings/summary - Canton Network Docs
Skip to main content
POST
/
v0
/
scan-proxy
/
holdings
/
summary
Try it
/v0/scan-proxy/holdings/summary

cURL

curl --request POST \
  --url https://example.com/api/validator/v0/scan-proxy/holdings/summary \
  --header 'Content-Type: application/json' \
  --data '
{
  "migration_id": 123,
  "record_time": "2023-11-07T05:31:56Z",
  "owner_party_ids": [
    "<string>"
  ],
  "record_time_match": "exact",
  "as_of_round": 123
}
'
200
400
404
500
{
  "record_time": "2023-11-07T05:31:56Z",
  "migration_id": 123,
  "computed_as_of_round": 123,
  "summaries": [
    {
      "party_id": "<string>",
      "total_unlocked_coin": "<string>",
      "total_locked_coin": "<string>",
      "total_coin_holdings": "<string>",
      "accumulated_holding_fees_unlocked": "<string>",
      "accumulated_holding_fees_locked": "<string>",
      "accumulated_holding_fees_total": "<string>",
      "total_available_coin": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
migration_id
integer<int64>
required

The migration id for which to return the summary.

​
record_time
string<date-time>
required

The timestamp at which the contract set was active. This needs to be an exact timestamp, i.e., needs to correspond to a timestamp reported by /v0/state/acs/snapshot-timestamp if record_time_match is set to exact (which is the default). If record_time_match is set to at_or_before, this can be any timestamp, and the most recent snapshot at or before the given record_time will be returned.

​
owner_party_ids
string[]
required

The owners for which to compute the summary.

Minimum array length: 1
​
record_time_match
enum<string>
default:exact

How to match the record_time. "exact" requires the record_time to match exactly. "at_or_before" finds the most recent snapshot at or before the given record_time.

Available options:
exact,
at_or_before
​
as_of_round
integer<int64>

Compute holding fees as of this round. Defaults to the earliest open mining round.

Response

200
application/json

ok

​
record_time
string<date-time>
required

The same record_time as in the request.

​
migration_id
integer<int64>
required

The same migration_id as in the request.

​
computed_as_of_round
integer<int64>
required

The same as_of_round as in the request, with the same default.

​
summaries
object[]
required

Show child attributes

Assistant
Responses are generated using AI and may contain mistakes.