Avalanche · Schema

NativeTokenBalance

BlockchainWeb3AvalancheNFTDeFiCross-Chain

Properties

Name Type Description
name string The contract name.
symbol string The contract symbol.
decimals number The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
logoUri string The logo uri for the address.
chainId string The evm chain id.
price object The token price, if available.
balance string The address balance for the token, in units specified by the `decimals` value for the contract.
balanceValue object The monetary value of the balance, if a price is available for the token.
View JSON Schema on GitHub

JSON Schema

NativeTokenBalance.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalanche/main/json-schema/NativeTokenBalance.json",
  "title": "NativeTokenBalance",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The contract name.",
      "examples": [
        "Wrapped AVAX"
      ]
    },
    "symbol": {
      "type": "string",
      "description": "The contract symbol.",
      "examples": [
        "WAVAX"
      ]
    },
    "decimals": {
      "type": "number",
      "description": "The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.",
      "examples": [
        18
      ]
    },
    "logoUri": {
      "type": "string",
      "description": "The logo uri for the address.",
      "examples": [
        "https://images.ctfassets.net/gcj8jwzm6086/5VHupNKwnDYJvqMENeV7iJ/fdd6326b7a82c8388e4ee9d4be7062d4/avalanche-avax-logo.svg"
      ]
    },
    "chainId": {
      "type": "string",
      "description": "The evm chain id.",
      "examples": [
        "43114"
      ]
    },
    "price": {
      "description": "The token price, if available.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "balance": {
      "type": "string",
      "description": "The address balance for the token, in units specified by the `decimals` value for the contract.",
      "examples": [
        "2000000000000000000"
      ]
    },
    "balanceValue": {
      "description": "The monetary value of the balance, if a price is available for the token.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    }
  },
  "required": [
    "name",
    "symbol",
    "decimals",
    "chainId",
    "balance"
  ]
}