getBalance

Query your balances on Akashic

Example

TypeScript

const balances = await akashicPay.getBalance();

PHP

$balances = akashicPay->getBalance();

Java

APBalanceResult balances = akashicPay.getBalance(l2Address);

C#

var balance = await akashicPay.GetBalanceAsync();

Return Example

Returns an array of objects, one for each native currency and one for each token with a non-zero balance. In the example below the caller has no USDT balance of ETH, hence there is no object for that instance.

Note: An object is always returned for native currencies. Tokens are only shown if you posses a non-zero amount.

TypeScript

[
  {
    "coinSymbol": NetworkSymbol.Ethereum_Sepolia,
    "balance": "5.000000000000000000"
  },
  {
    "coinSymbol": NetworkSymbol.Tron_Shasta,
    "balance": "34.000000"
  },
  {
    "coinSymbol": NetworkSymbol.Tron_Shasta,
    "tokenSymbol": TokenSymbol.USDT,
    "balance": "100.500000"
  },
]

PHP

[
  {
    "coinSymbol": NetworkSymbol::ETHEREUM_SEPOLIA,
    "balance": "5.000000000000000000"
  },
  {
    "coinSymbol": NetworkSymbol::TRON_SHASTA,
    "balance": "34.000000"
  },
  {
    "coinSymbol": NetworkSymbol::TRON_SHASTA,
    "tokenSymbol": TokenSymbol::USDT,
    "balance": "100.500000"
  },
]

Java

[
  {
    "coinSymbol": APNetworkSymbol.SEP,
    "balance": "5.000000000000000000"
  },
  {
    "coinSymbol": APNetworkSymbol.TRX_SHASTA,
    "balance": "34.000000"
  },
  {
    "coinSymbol": APNetworkSymbol.TRX_SHASTA,
    "tokenSymbol": APTokenSymbol.USDT,
    "balance": "100.500000"
  },
]

C#

  "Balances": [
    {
      "NetworkSymbol": EthSepNetworkSymbol,
      "TokenSymbol": ApTokenSymbol.Native,
      "Balance": "0.00123123"
    },
    {
      "NetworkSymbol": EthSepNetworkSymbol,
      "TokenSymbol": ApTokenSymbol.Usdt,
      "Balance": "150.52"
    },
    {
      "NetworkSymbol": TronShastaNetworkSymbol,
      "TokenSymbol": ApTokenSymbol.Native,
      "Balance": "1200.4"
    },
    {
      "NetworkSymbol": TronShastaNetworkSymbol,
      "TokenSymbol": ApTokenSymbol.Usdt,
      "Balance": "353.56"
    }
  ]
}