Skip to content
Documentation/canton-network-docs/Splice APIsToken Standard APIsToken Metadata ServiceView on canton-network-docs
canton-network-docs/Splice APIsToken Standard APIsToken Metadata Service

GET /registry/metadata/v1/instruments

GET
/
registry
/
metadata
/
v1
/
instruments
Try it
GET /registry/metadata/v1/instruments

cURL

curl --request GET \
  --url https://api.example.com/registry/metadata/v1/instruments
import requests

url = "https://api.example.com/registry/metadata/v1/instruments"

response = requests.get(url)

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

fetch('https://api.example.com/registry/metadata/v1/instruments', 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://api.example.com/registry/metadata/v1/instruments",
  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://api.example.com/registry/metadata/v1/instruments"

	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://api.example.com/registry/metadata/v1/instruments")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/registry/metadata/v1/instruments")

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
404
500
{
  "instruments": [
    {
      "id": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 10,
      "supportedApis": {},
      "totalSupply": "<string>",
      "totalSupplyAsOf": "2023-11-07T05:31:56Z",
      "paused": false,
      "pauseInfo": {
        "reason": "<string>",
        "until": "2023-11-07T05:31:56Z"
      },
      "showAccountInputFields": false,
      "accountInputFieldsToShow": []
    }
  ],
  "nextPageToken": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Query Parameters

pageSize
integer<int32>
default:25

Number of instruments per page.

pageToken
string

The nextPageToken received from the response for the previous page.

Response

200
application/json

ok

instruments
object[]
required

Show child attributes

nextPageToken
string

The token for the next page of results, to be used as the lastInstrumentId for the next page.