GET /registry/metadata/v1/instruments/:instrumentId

Retrieve an instrument’s metadata.

GET /registry/metadata/v1/instruments/{instrumentId}

GET /registry/metadata/v1/instruments/:instrumentId

cURL

curl --request GET \
  --url https://api.example.com/registry/metadata/v1/instruments/{instrumentId}

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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

	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/{instrumentId}")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "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": []
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Path Parameters

instrumentId · string · required

Response

200

application/json

ok

id · string · required

The unique identifier assigned by the admin to the instrument.

name · string · required

The display name for the instrument recommended by the instrument admin. This is not necessarily unique.

symbol · string · required

The symbol for the instrument recommended by the instrument admin. This is not necessarily unique.

decimals · integer<int8> · default: 10 · required

The number of decimal places used by the instrument.

Must be a number between 0 and 10, as the Daml interfaces represent holding amounts as Decimal values, which use 10 decimal places and are precise for 38 digits. Setting this to 0 means that the instrument can only be held in whole units.

This number SHOULD be used for display purposes in a wallet to decide how many decimal places to show and accept when displaying or entering amounts.

supportedApis · object · required

Map from token standard API name to the minor version of the API supported, e.g., splice-api-token-metadata-v1 -> 1 where the 1 corresponds to the minor version.

Show child attributes

totalSupply · string

Decimal encoded current total supply of the instrument.

totalSupplyAsOf · string<date-time>

The timestamp when the total supply was last computed.

paused · boolean · default: false

Indicates whether the instrument is currently paused. A paused instrument cannot be transferred or allocated.

pauseInfo · object

Additional information about the instrument pause state.

Show child attributes

showAccountInputFields · boolean · default: false · deprecated

Informs wallets whether the instrument supports non-basic accounts and the wallet should thus show input fields for both the account provider and the account id in input forms for transfers and allocations.

Note that wallets should always show non-null account providers and account ids when displaying transfers and allocations.

This property is deprecated in favor of the more fine-grained accountInputFieldsToShow property.

accountInputFieldsToShow · enum<string>[]

Fine-grained control for account input field display in wallets.

If set, then wallets should only display the specified input field(s) in transfer and allocation input forms independently of the showAccountInputFields property.

Note that wallets should always show non-null account providers and account ids when displaying transfers and allocations.

Which single account input field wallets should show in forms.

Available options: provider, accountId