Holdings state at v2

POST /api/scan/v2/holdings/state

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v2/holdings/state' \
  --header 'Content-Type: application/json' \
  --data '{"migration_id":0,"record_time":"2026-01-01T00:00:00Z","record_time_match":"exact","after":"string","page_size":0,"owner_party_ids":["string"]}'

200 response

{
  "record_time": "2026-01-01T00:00:00Z",
  "migration_id": 0,
  "created_events": [
    {}
  ],
  "next_page_token": "string"
}

Scan API

Holdings state at v2

OpenAPIAdded 0.7.5

Returns the active amulet contracts for a given migration id and record time, in creation date ascending order, paged.

Protocol Details

Operation IDgetHoldingsStateAtV2

Published0.7.5

SpecificationDownload OpenAPI

Inputs

Request body

application/json

migration_id · number · required

OpenAPI type: integer (int64).

The migration id for which to return the ACS.

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.

after · string

Pagination token for the next page of results. This token is opaque and not meant to be edited by users.

page_size · number · required

OpenAPI type: integer (int32).

The maximum number of created events returned for this request.

owner_party_ids · string[] · required

Filters by contracts in which these party_ids are the owners of the amulets.

Outputs

200

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.

created_events · ActiveContract[] · required

Up to page_size contracts in the ACS. create_arguments are always encoded as compact_json.

next_page_token · string

When requesting the next page of results, pass this as after to the AcsRequestV2 or HoldingsStateRequestV2. Will be absent when there are no more pages. This token is opaque and not meant to be edited by users.

400

application/json

error · string · required

404

application/json

error · string · required

500

application/json

error · string · required

History

Added0.7.5

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v2/holdings/state' \
  --header 'Content-Type: application/json' \
  --data '{"migration_id":0,"record_time":"2026-01-01T00:00:00Z","record_time_match":"exact","after":"string","page_size":0,"owner_party_ids":["string"]}'

200 response

{
  "record_time": "2026-01-01T00:00:00Z",
  "migration_id": 0,
  "created_events": [
    {}
  ],
  "next_page_token": "string"
}