canton-network-docs/Splice APIsScan APIsScan API
POST /v0/events
POST /v0/events
cURL
curl --request POST \
--url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events \
--header 'Content-Type: application/json' \
--data '
{
"page_size": 500
}
'import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events"
payload = { "page_size": 500 }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({page_size: 500})
};
fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page_size' => 500
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events"
payload := strings.NewReader("{\n \"page_size\": 500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events")
.header("Content-Type", "application/json")
.body("{\n \"page_size\": 500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"page_size\": 500\n}"
response = http.request(request)
puts response.read_body200
400
500
{
"events": [
{
"update": {
"update_id": "<string>",
"migration_id": 123,
"workflow_id": "<string>",
"record_time": "<string>",
"synchronizer_id": "<string>",
"effective_at": "<string>",
"root_event_ids": [
"<string>"
],
"events_by_id": {},
"external_transaction_hash": "<string>"
},
"verdict": {
"update_id": "<string>",
"migration_id": 123,
"domain_id": "<string>",
"record_time": "<string>",
"finalization_time": "<string>",
"submitting_parties": [
"<string>"
],
"submitting_participant_uid": "<string>",
"mediator_group": 123,
"transaction_views": {
"views": [
{
"view_id": 123,
"informees": [
"<string>"
],
"confirming_parties": [
{
"parties": [
"<string>"
],
"threshold": 123
}
],
"sub_views": [
123
],
"view_hash": "<string>"
}
],
"root_views": [
123
]
}
},
"traffic_summary": {
"total_traffic_cost": 123,
"envelope_traffic_summaries": [
{
"traffic_cost": 123,
"view_ids": [
123
]
}
]
},
"app_activity_records": {
"round_number": 123,
"records": [
{
"party": "<string>",
"weight": 123
}
]
}
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}POST
/
v0
/
events
POST /v0/events
cURL
curl --request POST \
--url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events \
--header 'Content-Type: application/json' \
--data '
{
"page_size": 500
}
'import requests
url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events"
payload = { "page_size": 500 }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({page_size: 500})
};
fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page_size' => 500
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events"
payload := strings.NewReader("{\n \"page_size\": 500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events")
.header("Content-Type", "application/json")
.body("{\n \"page_size\": 500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"page_size\": 500\n}"
response = http.request(request)
puts response.read_body200
400
500
{
"events": [
{
"update": {
"update_id": "<string>",
"migration_id": 123,
"workflow_id": "<string>",
"record_time": "<string>",
"synchronizer_id": "<string>",
"effective_at": "<string>",
"root_event_ids": [
"<string>"
],
"events_by_id": {},
"external_transaction_hash": "<string>"
},
"verdict": {
"update_id": "<string>",
"migration_id": 123,
"domain_id": "<string>",
"record_time": "<string>",
"finalization_time": "<string>",
"submitting_parties": [
"<string>"
],
"submitting_participant_uid": "<string>",
"mediator_group": 123,
"transaction_views": {
"views": [
{
"view_id": 123,
"informees": [
"<string>"
],
"confirming_parties": [
{
"parties": [
"<string>"
],
"threshold": 123
}
],
"sub_views": [
123
],
"view_hash": "<string>"
}
],
"root_views": [
123
]
}
},
"traffic_summary": {
"total_traffic_cost": 123,
"envelope_traffic_summaries": [
{
"traffic_cost": 123,
"view_ids": [
123
]
}
]
},
"app_activity_records": {
"round_number": 123,
"records": [
{
"party": "<string>",
"weight": 123
}
]
}
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}Body
application/json
The maximum number of events returned for this request.
Required range:
1 <= x <= 1000The events returned will either have a higher migration id or the same migration id and a record_time greater than the migration id and record time specified.
Show child attributes
Show child attributes
How daml values should be encoded in the response. "compact_json" is a compact, human-readable JSON encoding. It is the same encoding as the one used in the HTTP JSON API or the JavaScript codegen. "protobuf_json" is a verbose JSON encoding that is more difficult to parse, but contains type information, i.e., the values can be parsed losslessly without having access to the Daml source code. Optional and defaults to "compact_json".
Available options:
compact_json, protobuf_json Response
200
application/json
ok
Show child attributes
Show child attributes
Was this page helpful?
⌘I