Virtual Currency

Get virtual currency

/v3/ledger/virtualCurrency/{name}

1 credit per API call

Get detail of virtual currency.

get/v3/ledger/virtualCurrency/{name}

Request

Base URL
https://api.tatum.io
URL
https://api.tatum.io/v3/ledger/virtualCurrency/{name}
Auth
API key in header x-api-key

Path parameters

namestring required

Response

namestring required

Virtual currency name. Must be prefixed with 'VC_'.

supplystring required

Supply of virtual currency.

accountIdstring required

Virtual currency account.

baseRatenumber required

Exchange rate of the base pair. Each unit of the created curency will represent value of baseRate*1 basePair.

precisionnumber

Number of decimal places of this virtual currency.

trcType'TRC10' | 'TRC20'

Type of Tron token.

basePair'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'ALGO' | 'ADA' | 'BAM' | 'BAT' | 'BBD' | 'BCH' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BNB' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DOGE' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'ETH' | 'EUR' | 'FJD' | 'FKP' | 'FREE' | 'GMC' | 'GMC_BSC' | 'RMD' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LEO' | 'LINK' | 'LKR' | 'LRD' | 'LSL' | 'LTC' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MATIC' | 'MDL' | 'MGA' | 'MKD' | 'MKR' | 'MMK' | 'MMY' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PAX' | 'PAXG' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TRON' | 'TUSD' | 'BUSD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UNI' | 'USD' | 'USDC' | 'USDC_MATIC' | 'USDC_MATIC_NATIVE' | 'USDT' | 'USDT_TRON' | 'USDT_MATIC' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WBTC' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XCON' | 'XDR' | 'XOF' | 'XPF' | 'XRP' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL' required

customerIdstring

ID of customer associated with virtual currency.

descriptionstring

Used as a description within Tatum system.

erc20Addressstring

Address of ERC20 token, when virtual currency is based on the Ethereum blockchain.

issuerAccountstring

Blockchain account for XLM or XRP based virtual currencies, which is marked as the issuer of the custom blockchain asset.

chain'ETH' | 'XRP' | 'XLM'

Blockchain, on which this virtual currency is paired on. Not present, when Tatum's private ledger is used as a base ledger.

initialAddressstring

Ethereum address, where initial supply was minted, when virtual currency is based on the Ethereum blockchain.

Example response

{
  "name": "VC_VIRTUAL",
  "supply": "1000000",
  "accountId": "5e68c66581f2ee32bc354087",
  "precision": 6,
  "trcType": "TRC20",
  "customerId": "5e68c66581f2ee32bc354087",
  "description": "My Virtual Token description.",
  "erc20Address": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85",
  "issuerAccount": "GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT",
  "chain": "ETH",
  "initialAddress": "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
}

Changes

No recorded changes to this operation across all 1 revision of this API.