Retrieve Account DeFi

Support Protocols

• Uniswap: V2, V3, and V4
• PancakeSwap: V2 and V3
• Morpho
• Aave V3
• Gearbox
• Capricorn
• Curve
• Euler
• Curvance
• Neverland
• Upshift
• Atlantis
• Balancer
• Townsquare
• Pendle
• LeverUp
• Perpl
• Kuru

Parameter

• address, string - a 42 character address with '0 x' as prefix. The wallet address to check for ERC-20 tokens.

Response

• code, number - response status code, e.g., 0 for success.
• message, string - response message, e.g., OK.
• result, array object - result object protocol portfolio.
  • logo, string - URL to the protocol logo.
  • name, string - the name of the protocol.
  • website, string - protocol website URL.
  • items, array object - object protocol portfolio items.
    • type, string - item type (eg: "liquidity_pool").
    • data, object - liquidity pool data object.
      • isOut, boolean - indicates if the pool is active/inactive.
      • poolId, string - unique pool identifier (contract address).
      • fee, number - pool fee percentage (decimal format).
      • token0, string - contract address of the first token.
      • token1, string - contract address of the second token.
      • balance0, string - balance of token0 in the pool (in wei).
      • balance1, string - balance of token1 in the pool (in wei).
      • rewards, array - array of reward amounts (in wei).
      • tokenDetail0, Token Details Object - detailed information for token.
• Token Details Object Both tokenDetail0 and tokenDetail1 follow this structure:
  • contractAddress, string - token contract address.
  • logo, string - URL to token logo image.
  • symbol, string - token symbol (e.g., "DAK", "WMON").
  • decimals, number - number of decimal places for the token.
  • name, string - full token name.
  • verified, boolean - whether the token is verified.

Assets item Response

• type, string - item type (eg: "assets").
• data, object - assets data object.
  • symbol, string - token symbol (e.g., "DAK", "WMON").
  • logo, string - URL to token logo image.
  • balance, number - balance of token0 in the pool (in wei).
  • decimals, string - number of decimal places for the token.
  • contractAddress, string - token contract address.
  • targetToken, string - the address of the underlying target token.
  • apy, number - annual percentage yield (decimal format).
  • key, array - token type identifier indicating lending/collateral status.
  • verified, boolean - whether the token is verified.

Token Key Types

The key field indicates the token's role in the lending protocol:

• itoken - Lending Token: Used for lending operations only.
• ctoken - Collateral Token: Used as collateral only.
• ictoken - Lending + Collateral Token: Can be used for both lending and as collateral.

Debts item Response

• type, string - item type (eg: "debts").
• data, object - assets data object.
  • symbol, string - token symbol (e.g., "DAK", "WMON").
  • logo, string - URL to token logo image.
  • balance, number - balance of token0 in the pool (in wei).
  • decimals, string - number of decimal places for the token.
  • contractAddress, string - token contract address.
  • targetToken, string - the address of the underlying target token.
  • apy, number - annual percentage yield (decimal format).
  • key, array - token type identifier indicating debt status.
  • verified, boolean - whether the token is verified.

Multi-token Pool item Response

Used by protocols such as Curve, Balancer, and Beefy pool positions.

• type, string - item type (eg: "liquidity_pool" or "positions").
• data, object - multi-token pool position data object.
  • poolId, string - unique pool identifier.
  • poolName, string - pool name.
  • poolSymbol, string - pool symbol.
  • coins, array - token contract addresses in the pool.
  • balances, array - account balances for each pool token.
  • decimals, array - number of decimal places for each pool token.
  • symbols, array - token symbols.
  • logos, array - token logo image URLs.
  • apr, number - annual percentage rate (decimal format).

Lends item Response

Used by vault and yield protocols such as Upshift, Beefy, and Pendle.

• type, string - item type (eg: "lends", "deposits", or "vault").
• data, object - lending or vault position data object.
  • symbol, string - token symbol (e.g., "DAK", "WMON").
  • logo, string - URL to token logo image.
  • balance, string - token balance in base units.
  • decimals, number - number of decimal places for the token.
  • contractAddress, string - token contract address.
  • targetToken, string - the address of the underlying token, vault token, market token, or related protocol token.
  • apy, number - annual percentage yield (decimal format).
  • apr, number - annual percentage rate (decimal format).
  • key, string - protocol-specific token role or position mode.
  • name, string - protocol-specific position or vault name.
  • account, string - protocol account identifier.
  • verified, boolean - whether the token is verified.

Rewards item Response

Used by protocols that expose unclaimed rewards, such as Neverland and Pendle.

• type, string - item type (eg: "rewards").
• data, object - reward position data object.
  • symbol, string - reward token symbol.
  • logo, string - URL to reward token logo image.
  • balance, string - reward token amount in base units.
  • decimals, number - number of decimal places for the reward token.
  • contractAddress, string - reward token contract address.
  • verified, boolean - whether the reward token is verified.

Perps item Response

Used by perpetual protocols such as LeverUp and Perpl.

• type, string - item type (eg: "perps").
• data, object - perpetual protocol data object.
  • totalValueUsd, string - total account value in USD.
  • perps, array object - open perpetual positions.
    • positionHash, string - unique position identifier.
    • pair, string - trading pair (e.g., "MON/AUSD").
    • pairIcon, string - URL to pair icon.
    • side, string - position side, long or short.
    • entryPrice, string - entry price.
    • marketPrice, string - current market price.
    • marginUsd, string - margin value in USD.
    • sizeUsd, string - position size in USD.
    • pnlUsd, string - unrealized PnL in USD.
    • pnlPercentage, string - unrealized PnL percentage.
    • netValueUsd, string - net position value in USD.
    • leverage, string - position leverage.
  • deposits, array object - collateral deposited in the protocol account.
  • staking, array object - earn or staking positions.

Deposits and Staking item Response

Used by protocols that expose protocol account balances, collateral deposits, earn products, or staking balances.

• type, string - item type (eg: "deposits" or "staking").
• data, object - deposit or staking position data object.
  • symbol, string - token symbol.
  • logo, string - URL to token logo image.
  • balance, string - token balance in base units.
  • decimals, number - number of decimal places for the token.
  • contractAddress, string - token contract address.
  • targetToken, string - related vault, staking, or collateral token address.
  • verified, boolean - whether the token is verified.
  • apy, number - annual percentage yield (decimal format).
  • name, string - product or vault name.
  • valueUsd, string - position value in USD.