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

GET /v0/dso

GET
/
v0
/
dso
Try it
GET /v0/dso

cURL

curl --request GET \
  --url https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso
import requests

url = "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso', 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/dso",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/dso")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
200
{
  "sv_user": "<string>",
  "sv_party_id": "<string>",
  "dso_party_id": "<string>",
  "voting_threshold": 123,
  "latest_mining_round": {
    "contract": {
      "template_id": "<string>",
      "contract_id": "<string>",
      "payload": {},
      "created_event_blob": "<string>",
      "created_at": "<string>"
    },
    "domain_id": "<string>"
  },
  "amulet_rules": {
    "contract": {
      "template_id": "<string>",
      "contract_id": "<string>",
      "payload": {},
      "created_event_blob": "<string>",
      "created_at": "<string>"
    },
    "domain_id": "<string>"
  },
  "dso_rules": {
    "contract": {
      "template_id": "<string>",
      "contract_id": "<string>",
      "payload": {},
      "created_event_blob": "<string>",
      "created_at": "<string>"
    },
    "domain_id": "<string>"
  },
  "sv_node_states": [
    {
      "contract": {
        "template_id": "<string>",
        "contract_id": "<string>",
        "payload": {},
        "created_event_blob": "<string>",
        "created_at": "<string>"
      },
      "domain_id": "<string>"
    }
  ],
  "initial_round": "<string>"
}

Response

200 - application/json

ok

​
sv_user
string
required

User ID representing the SV

​
sv_party_id
string
required

Party representing the SV

​
dso_party_id
string
required

Party representing the whole DSO; for Scan only, also returned by /v0/dso-party-id

​
voting_threshold
integer
required

Threshold required to pass vote requests; also known as the "governance threshold", it is always derived from the number of svs in dso_rules

​
latest_mining_round
object
required

Contract of the Daml template Splice.Round.OpenMiningRound, the one with the highest round number on the ledger that has been signed by dso_party_id. The round may not be usable as it may not be opened yet, in accordance with its opensAt template field

Show child attributes

​
amulet_rules
object
required

Contract of the Daml template Splice.AmuletRules.AmuletRules, including the full schedule of AmuletConfig changes approved by the DSO. Callers should not assume that initialValue is up-to-date, and should instead search futureValues for the latest configuration valid as of now

Show child attributes

​
dso_rules
object
required

Contract of the Daml template Splice.DsoRules.DsoRules, listing the governance rules approved by the DSO governing this Splice network.

Show child attributes

​
sv_node_states
object[]
required

For every one of svs listed in dso_rules, a contract of the Daml template Splice.DSO.SvState.SvNodeState. This does not include states for offboarded SVs, though they may still have an on-ledger state contract

Show child attributes

​
initial_round
string

Initial round from which the network bootstraps