Skip to main content
GET

Token Metadata Service

​
Retrieve an instrument’s metadata

OpenAPISince 0.5.10Changed 0.6.12
Retrieve an instrument’s metadata.

​
Protocol Details

Operation IDgetInstrument
Published0.7.4
SpecificationDownload OpenAPI

​
Inputs

​
Path parameters

​
string
required

​
Outputs

​
200

application/json
​
string
required
The unique identifier assigned by the admin to the instrument.
​
string
required
The display name for the instrument recommended by the instrument admin. This is not necessarily unique.
​
string
required
The symbol for the instrument recommended by the instrument admin. This is not necessarily unique.
​
string
Decimal encoded current total supply of the instrument.
​
string (date-time)
The timestamp when the total supply was last computed.
​
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.
​
boolean
default:"False"
Indicates whether the instrument is currently paused. A paused instrument cannot be transferred or allocated.
​
PauseInfo
Additional information about the instrument pause state.
​
SupportedApis
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.
​
boolean
default:"False"
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
Which account input field(s) wallets should show in forms.

​
404

application/json
​
string
required

​
500

application/json
​
string
required

​
History

Changed0.6.12

The GET /registry/metadata/v1/instruments/{instrumentId} operation changed in this snapshot.

Changed0.6.11

The GET /registry/metadata/v1/instruments/{instrumentId} operation changed in this snapshot.

Introduced0.5.10