Avalanche · Schema

Erc20TokenBalance

BlockchainWeb3AvalancheNFTDeFiCross-Chain

Properties

Name Type Description
address string A wallet or contract address in mixed-case checksum encoding.
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.
ercType string
price object The token price, if available.
chainId string The evm chain id.
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.
tokenReputation stringnull Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious' indicates potential security risks. This field is nullable and is only
View JSON Schema on GitHub

JSON Schema

Erc20TokenBalance.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalanche/main/json-schema/Erc20TokenBalance.json",
  "title": "Erc20TokenBalance",
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "description": "A wallet or contract address in mixed-case checksum encoding.",
      "examples": [
        "0x71C7656EC7ab88b098defB751B7401B5f6d8976F"
      ]
    },
    "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"
      ]
    },
    "ercType": {
      "type": "string",
      "enum": [
        "ERC-20"
      ]
    },
    "price": {
      "description": "The token price, if available.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "chainId": {
      "type": "string",
      "description": "The evm chain id.",
      "examples": [
        "43114"
      ]
    },
    "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"
        }
      ]
    },
    "tokenReputation": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Malicious",
        "Benign"
      ],
      "description": "Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious'  indicates potential security risks. This field is nullable and is only populated for tokens on the C-Chain. Possible values are 'Benign', 'Malicious', or null if the  reputation is unknown.",
      "examples": [
        "Malicious",
        "Benign",
        null
      ]
    }
  },
  "required": [
    "address",
    "name",
    "symbol",
    "decimals",
    "ercType",
    "chainId",
    "balance",
    "tokenReputation"
  ]
}