Documentation/canton-network-docs/Splice APIsScan APIsScan APIView on canton-network-docs ↗
canton-network-docs/Splice APIsScan APIsScan API

/v0/transactions

POST
/
v0
/
transactions
Try it
/v0/transactions

cURL

curl --request POST \
  --url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/transactions \
  --header 'Content-Type: application/json' \
  --data '
{
  "page_size": 123,
  "page_end_event_id": "<string>"
}
'
200
400
404
500
{
  "transactions": [
    {
      "event_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "domain_id": "<string>",
      "offset": "<string>",
      "round": 123,
      "transfer": {
        "sender": {
          "party": "<string>",
          "sender_change_fee": "<string>",
          "sender_change_amount": "<string>",
          "sender_fee": "<string>",
          "holding_fees": "<string>",
          "input_amulet_amount": "<string>",
          "input_app_reward_amount": "<string>",
          "input_validator_reward_amount": "<string>",
          "input_sv_reward_amount": "<string>",
          "input_validator_faucet_amount": "<string>"
        },
        "receivers": [
          {
            "party": "<string>",
            "amount": "<string>",
            "receiver_fee": "<string>"
          }
        ],
        "balance_changes": [
          {
            "party": "<string>",
            "change_to_initial_amount_as_of_round_zero": "<string>",
            "change_to_holding_fees_rate": "<string>"
          }
        ],
        "description": "<string>",
        "transferInstructionReceiver": "<string>",
        "transferInstructionAmount": "<string>",
        "transferInstructionCid": "<string>"
      },
      "mint": {
        "amulet_owner": "<string>",
        "amulet_amount": "<string>"
      },
      "tap": {
        "amulet_owner": "<string>",
        "amulet_amount": "<string>"
      },
      "abort_transfer_instruction": {
        "transfer_instruction_cid": "<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
​
page_size
integer<int64>
required

The maximum number of transactions returned for this request.

​
page_end_event_id
string

Note that all transactions carry some monotonically-increasing event_id. Omit this page_end_event_id to start reading the first page, from the beginning or the end of the ledger, depending on the sort_order column. A subsequent request can fill the page_end_event_id with the last event_id of the TransactionHistoryResponse to continue reading in the same sort_order. The transaction with event_id == page_end_event_id will be skipped in the next response, making it possible to continuously read pages in the same sort_order.

​
sort_order
enum<string>

Sort order for the transactions. For ascending order, from beginning to the end of the ledger, use "asc". For descending order, from end to beginning of the ledger, use "desc". "asc" is used if the sort_order is omitted.

Available options:
asc,
desc

Response

200
application/json

ok

​
transactions
object[]
required

Show child attributes