Skip to content
CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Splice APIsValidator APIsScan Proxy APIView on Canton Network Docs

POST /v1/scan-proxy/holdings/summary

POST
/
api
/
validator
/
v1
/
scan-proxy
/
holdings
/
summary
Try it
cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request POST \
  --url 'https://example.com/api/validator/v1/scan-proxy/holdings/summary' \
  --header 'Content-Type: application/json' \
  --data '{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}'
import json
import requests

url = "https://example.com/api/validator/v1/scan-proxy/holdings/summary"
headers = {'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)
const response = await fetch('https://example.com/api/validator/v1/scan-proxy/holdings/summary', {
  method: 'POST',
  headers: {
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}),
});

console.log(await response.text());
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.com/api/validator/v1/scan-proxy/holdings/summary',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;
package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://example.com/api/validator/v1/scan-proxy/holdings/summary", bytes.NewBufferString(`{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}`))
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://example.com/api/validator/v1/scan-proxy/holdings/summary"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'

uri = URI('https://example.com/api/validator/v1/scan-proxy/holdings/summary')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
400
404
500
{
  "record_time": "2026-01-01T00:00:00Z",
  "migration_id": 123,
  "summaries": [
    {
      "party_id": "<string>",
      "total_unlocked_coin": "<string>",
      "total_locked_coin": "<string>",
      "total_coin_holdings": "<string>"
    }
  ]
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Returns the summary of active amulet contracts for a given migration id and record time, for the given parties. This is an aggregate of /v0/holdings/state by owner party ID with better performance than client-side computation. Unlike /v0/scan-proxy/holdings/summary, this version does not include holding fee fields as they do not express a meaningful aggregate value.

cURL
Python
JavaScript
PHP
Go
Java
Ruby
curl --request POST \
  --url 'https://example.com/api/validator/v1/scan-proxy/holdings/summary' \
  --header 'Content-Type: application/json' \
  --data '{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}'
import json
import requests

url = "https://example.com/api/validator/v1/scan-proxy/holdings/summary"
headers = {'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)
const response = await fetch('https://example.com/api/validator/v1/scan-proxy/holdings/summary', {
  method: 'POST',
  headers: {
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}),
});

console.log(await response.text());
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.com/api/validator/v1/scan-proxy/holdings/summary',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;
package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://example.com/api/validator/v1/scan-proxy/holdings/summary", bytes.NewBufferString(`{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}`))
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://example.com/api/validator/v1/scan-proxy/holdings/summary"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'

uri = URI('https://example.com/api/validator/v1/scan-proxy/holdings/summary')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "migration_id": 123,
  "record_time": "2026-01-01T00:00:00Z",
  "record_time_match": "exact",
  "owner_party_ids": [
    "<string>"
  ]
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body
200
400
404
500
{
  "record_time": "2026-01-01T00:00:00Z",
  "migration_id": 123,
  "summaries": [
    {
      "party_id": "<string>",
      "total_unlocked_coin": "<string>",
      "total_locked_coin": "<string>",
      "total_coin_holdings": "<string>"
    }
  ]
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Body

application/json
migration_id
number
required
OpenAPI type: integer (int64).The migration id for which to return the summary.
record_time
string
required
OpenAPI type: string (date-time).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.
record_time_match
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.Allowed values: exact, at_or_before.
owner_party_ids
string[]
required
The owners for which to compute the summary.Minimum items: 1.

Responses

200

ok
application/json
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.
summaries
HoldingsSummaryV1[]
required

Show child attributes

party_id
string
required
Owner party ID of the amulet. Guaranteed to be unique among summaries.
total_unlocked_coin
string
required
Sum of unlocked amulet initial amounts, not counting holding fees deducted since.
total_locked_coin
string
required
Sum of locked amulet initial amounts, not counting holding fees deducted since.
total_coin_holdings
string
required
total_unlocked_coin + total_locked_coin.

400

bad request
application/json
error
string
required

404

not found
application/json
error
string
required

500

internal server error
application/json
error
string
required

History

Added0.6.3