Retrieve a single MPT issuance by id (point-in-time), with flags decoded to booleans and XLS-89 metadata decoded.
token.retrieve(
params: TokenRetrieveParams,
): Promise<TokenRetrieveResult>| Parameter | Type | Required | Description |
|---|---|---|---|
mptIssuanceId | string | Yes | The MPT issuance id to fetch. |
Resolves to a TokenRetrieveResult:
| Field | Type | Description |
|---|---|---|
tokenID | string | The queried MPT issuance id. |
data | TokenData | undefined | The issuance snapshot, or undefined if no such issuance exists. |
| Field | Type | Description |
|---|---|---|
tokenID | string | The MPT issuance id. |
issuer | string | The issuer r-address. |
assetScale | number | Decimal places between display value and base units. |
maximumAmount | string (optional) | Maximum issuable amount (base units), if capped. |
outstandingAmount | string | Amount currently in circulation (base units). |
transferFee | number | Secondary-transfer fee, as a percentage. |
flags | TokenFlags | Capability flags decoded to booleans: canLock, requireAuth, canEscrow, canTrade, canTransfer, canClawback. |
metadata | MPTokenMetadata (optional) | Decoded XLS-89 metadata, if present and well-formed. |
Read-only — no signer is required and nothing is submitted. Queries the ledger with ledger_entry.
const { data } = await client.token.retrieve({
mptIssuanceId: '005C...',
})
console.log(data?.outstandingAmount)