OpenSea · Schema

TokenBalanceResponse

Token balance for a wallet address

NFTMarketplaceWeb3BlockchainTradingDigital Assets

Properties

Name Type Description
address string The contract address of the token
chain string The blockchain the token is on
name string The display name of the token
symbol string The ticker symbol of the token
image_url string URL of the token's image
usd_price string Current price in USD
decimals integer Number of decimal places
opensea_url string URL to the token page on OpenSea
quantity string Token balance in display units (divided by 10^decimals), not raw/wei
usd_value string Total USD value of the balance (quantity * usd_price)
status string Token status relative to OpenSea's spam-classification rules. `OK` for tokens that pass all spam filters (the normal case); populated with a more specific value for tokens surfaced via `disable_spam_f
base_token_liquidity_usd string USD value of base token reserves in the top liquidity pool paired with a curated quote token
quote_token_liquidity_usd string USD value of quote token reserves in the top liquidity pool paired with a curated quote token
View JSON Schema on GitHub

JSON Schema

TokenBalanceResponse.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opensea.io/schemas/TokenBalanceResponse",
  "title": "TokenBalanceResponse",
  "type": "object",
  "description": "Token balance for a wallet address",
  "properties": {
    "address": {
      "type": "string",
      "description": "The contract address of the token",
      "example": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
    },
    "chain": {
      "type": "string",
      "description": "The blockchain the token is on",
      "example": "ethereum"
    },
    "name": {
      "type": "string",
      "description": "The display name of the token",
      "example": "USD Coin"
    },
    "symbol": {
      "type": "string",
      "description": "The ticker symbol of the token",
      "example": "USDC"
    },
    "image_url": {
      "type": "string",
      "description": "URL of the token's image"
    },
    "usd_price": {
      "type": "string",
      "description": "Current price in USD",
      "example": 1
    },
    "decimals": {
      "type": "integer",
      "format": "int32",
      "description": "Number of decimal places",
      "example": 6
    },
    "opensea_url": {
      "type": "string",
      "description": "URL to the token page on OpenSea"
    },
    "quantity": {
      "type": "string",
      "description": "Token balance in display units (divided by 10^decimals), not raw/wei",
      "example": 1.5
    },
    "usd_value": {
      "type": "string",
      "description": "Total USD value of the balance (quantity * usd_price)",
      "example": 3518.51835185
    },
    "status": {
      "type": "string",
      "default": "OK",
      "description": "Token status relative to OpenSea's spam-classification rules. `OK` for tokens that pass all spam filters (the normal case); populated with a more specific value for tokens surfaced via `disable_spam_filtering=true` that would normally be hidden. Categories are intentionally broad and may evolve. Possible values, in decreasing severity: `WARNING` (flagged as risky/suspicious \u2014 caution advised), `SPAM` (flagged as spam), `LOW_LIQUIDITY` (insufficient pool liquidity), `LOW_VALUE` (dust holding < $0.01), `OK` (passes all filters).",
      "enum": [
        "OK",
        "WARNING",
        "SPAM",
        "LOW_LIQUIDITY",
        "LOW_VALUE"
      ]
    },
    "base_token_liquidity_usd": {
      "type": "string",
      "description": "USD value of base token reserves in the top liquidity pool paired with a curated quote token",
      "example": 125000.5
    },
    "quote_token_liquidity_usd": {
      "type": "string",
      "description": "USD value of quote token reserves in the top liquidity pool paired with a curated quote token",
      "example": 125000.5
    }
  },
  "required": [
    "address",
    "chain",
    "decimals",
    "name",
    "opensea_url",
    "quantity",
    "symbol",
    "usd_price",
    "usd_value"
  ]
}