Sign in

v1

latestOpenAPI 3.0.02026-07-22343639.7 KB
public

Retrieve an instrument's metadata.

get/api/token-standard/v0/registrars/{registrarParty}/registry/metadata/v1/instruments/{instrumentId}

Path parameters

registrarPartystring required

The registrar party.

instrumentIdstring required

Response

ok

idstring required

The unique identifier assigned by the admin to the instrument.

namestring required

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

symbolstring required

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

totalSupplystring

Decimal encoded current total supply of the instrument.

totalSupplyAsOfstring date-time

The timestamp when the total supply was last computed.

decimalsinteger 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.

supportedApisSupportedApis 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.