API Reference

Retrieve Account DeFi

get
https://api.blockvision.org/v2/sui/account/defiPortfolio

Return account‘s DeFi portfolio with any given top protocols on Sui Network

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Supported on Sui Mainnet.

🚧

The Account's DeFi Portfolio API on Sui is currently exclusively available to Pro Members. Non-Pro members can also enjoy a trial period with an allocation of 30 free calls. If you're interested, please register directly through here. Please note that the API Key can also be used for your RPC endpoint.


Parameter

  • address, string - a 32 Byte address with '0x' as prefix. The address to search for the account.
  • protocol, string - DeFi protocol (eg "cetus" or "navi").

Response

Aftermath

  • lpPositions, array object - list of liquidity pool positions held by the user.
    • poolId, string - unique identifier for the liquidity pool, e.g., 0xee7a281296e0a316eff84e7ea0d5f3eb19d1860c2d4ed598c086ceaa9bf78c75.
    • coins, array object - assets contributed to the liquidity pool.
      • amount, string - quantity of coins in the position, e.g., 90440232.
      • coinType, string - address and type of the coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
  • farmPositions, array object - list of farming positions held by the user.
    • poolId, string - unique identifier for the farm pool, e.g., 0x20672ed3b848ad0e8613d027ee579cfad9db4a551b82115dc0a8d1f8dcd78c65.
    • coins, array object - assets staked in the farm.
      • amount, string - quantity of coins staked, e.g., 227034363.
      • coinType, string - address and type of the coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • rewards, array object - rewards earned from farming.
      • coinType, string - address and type of the reward coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
      • amount, string - quantity of rewards accrued, e.g., 7467794.

AlphaFi

  • strategies
  • poolId, string - unique identifier for the pool, e.g., 0xc696ca5b8f21a1f8fcd62cff16bbe5a396a4bed6f67909cfec8269eb16e60757.
  • poolName, string - human-readable name of the pool, e.g., NAVI-USDT or ALPHA.
  • coinTypeA, string - (for dual-coin pools) address and type of the first coin, e.g., 0xfe3afec26c59e874f3c1d60b8203cb3852d2bb2aa415df9548b8d688e6683f93::alpha::ALPHA.
  • coinTypeB, string - (for dual-coin pools) address and type of the second coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
  • apy, number - annual percentage rate of the pool, e.g., 7.732606 or 0.
  • valueA, string - e.g., 1.29.
  • valueB, string - e.g., 0.585985.

Alphalend

  • supply
    • coinType, string
    • decimals, number
    • apr, number
    • value, string
    • price, number - coin price
  • borrow
    • coinType, string
    • decimals, number
    • apr, number
    • value, string
  • rewards
      • coinType, string
      • value, string

Bluefin

  • lps, array object - list of liquidity provider positions.
    • isOut, boolean - indicates whether the position is out of range, e.g., true or false.
    • positionId, string - unique identifier for the position, e.g., 0x6038fdc45caa424c1f71bbc33e530d58969fcfec9d7aa005212bf1e6a0020f1e.
    • poolId, string - unique identifier for the liquidity pool, e.g., 0xbcc6909d2e85c06cf9cbfe5b292da36f5bfa0f314806474bbf6a0bf9744d37ce.
    • poolName, string - human-readable name of the pool, e.g., WAL-USDC.
    • coinTypeA, string - address and type of the first coin in the position, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • coinTypeB, string - address and type of the second coin in the position, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
    • coinAmountA, string - amount of the first coin in the position, e.g., 15146974329.
    • coinAmountB, string - amount of the second coin in the position, e.g., 932299395.
    • reward, object - rewards earned from the position.
      • rewards, array object - list of reward coins earned.
        • coinAmount, string - amount of reward coin, e.g., 124550005.
        • coinSymbol, string - symbol of the reward coin, e.g., WAL.
        • coinType, string - address and type of the reward coin, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
        • coinDecimals, number - decimal places for the reward coin, e.g., 9.
      • fee, object - fees earned from the position.
        • coinA, string - amount of fee earned in the first coin, e.g., 280753754.
        • coinB, string - amount of fee earned in the second coin, e.g., 125679.
    • feeRate, string - the fee rate for the pool, e.g., 0.20%.
    • apr, string - annual percentage rate for the position, e.g., 542.6364818.
  • usdcVault, object - information about USDC vault.
    • amount, string - amount of USDC in the vault, e.g., 3530000.
    • apy, string - annual percentage yield for the USDC vault, e.g., 14.207151946326524.
  • blueVault, object - information about BLUE token vault.
    • amount, string - amount of BLUE tokens in the vault, e.g., 5000000000.
    • apy, string - annual percentage yield for the BLUE vault, e.g., 8.178325619875908.

Bucket（legacy）

  • sBuck, array object
  • bottles, array object
  • tanks, array object
  • deButInfo, object
  • savings, array object
  • positions, array object

Bucket2

  • savings, array object
    • coinType, string
    • amount, string - the balance of sUSDB
    • usdbBalance , string - the balance of USDB
    • apr, number
    • rewards，array object
      • coinType, string
      • amount, string
  • positions, array object
    • coinType, string
    • amount, string
    • debtAmount, string - the balance of USDB debt
    • rewards，array object
      • coinType, string
      • amount, string

Cetus

  • farms, array object - list of farm positions.
    • isOut, boolean - indicates whether the position is out of range, e.g., false.
    • pool, string - unique identifier for the liquidity pool, e.g., 0xa8c90b015113ee7d53b02555d176f180850f0ded5e7ebebecbff26e1e74522cf.
    • position, string - unique identifier for the position, e.g., 0xc1d6518de0f835f8745948e7c5e0f2ff73752449987b67b680589149220e525c.
    • coinTypeA, string - address and type of the first coin, e.g., 0x8b4d553839b219c3fd47608a0cc3d5fcc572cb25d41b7df3833208586a8d2470::hawal::HAWAL.
    • coinTypeB, string - address and type of the second coin, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • balanceA, string - amount of the first coin in the position, e.g., 5177020726.
    • balanceB, string - amount of the second coin in the position, e.g., 3588207226.
    • name, string - name of the farm position, e.g., Cetus LP | Pool26135-655.
    • image_url, string - URL to the position's image, e.g., https://bq7bkvdje7gvgmv66hrxdy7wx5h5ggtrrnmt66rdkkehb64rvz3q.arweave.net/DD4VVGknzVMyvvHjceP2v0_TGnGLWT96I1KIcPuRrnc.
    • type, string - type of position, e.g., Farm.
    • lpType, string - clmm or dlmm
    • rewards, array object - list of reward coins earned.
      • amount, string - amount of reward coin, e.g., 202070717.
      • coinType, string - address and type of the reward coin, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • fees, object - fees earned from the position.
      • amountA, string - amount of fee earned in the first coin, e.g., 4092313.
      • amountB, string - amount of fee earned in the second coin, e.g., 16641766.
    • decimalsA, number - decimal places for the first coin, e.g., 9.
    • decimalsB, number - decimal places for the second coin, e.g., 9.
    • apr, number - annual percentage rate for the position, e.g., 57.06718119181304.
  • lps, array object - list of liquidity positions.
    • isOut, boolean - indicates whether the position is out of range, e.g., false.
    • pool, string - unique identifier for the liquidity pool, e.g., 0x72f5c6eef73d77de271886219a2543e7c29a33de19a6c69c5cf1899f729c3f17.
    • position, string - unique identifier for the position, e.g., 0x5b2d3eaf4b864dd7fff0f3a912023a59f5761f5bb7cb6fc9236683e3338d0c5c.
    • coinTypeA, string - address and type of the first coin, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • coinTypeB, string - address and type of the second coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • balanceA, string - amount of the first coin in the position, e.g., 3189741863.
    • balanceB, string - amount of the second coin in the position, e.g., 332682349.
    • name, string - name of the liquidity position.
    • image_url, string - URL to the position's image.
    • type, string - type of position, e.g., Liquidity Pool.
    • rewards, array object - list of reward coins earned.
      • amount_owned, string - amount of reward coin, e.g., 487697.
      • coinType, string - type of the reward coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
      • decimals, number - decimal places for the reward coin, e.g., 9.
    • fees, object - fees earned from the position.
      • feeOwnedA, string - amount of fee earned in the first coin, e.g., f279eb.
      • feeOwnedB, string - amount of fee earned in the second coin, e.g., 291932.
    • coinTypeADecimals, number - decimal places for the first coin, e.g., 6.
    • coinTypeBDecimals, number - decimal places for the second coin, e.g., 6.
    • apr, number - annual percentage rate for the position, e.g., 520.247761776634.
  • vaults, array object - list of vault positions.
    • apy, string - annual percentage yield for the vault, e.g., 6.22913152.
    • id, string - unique identifier for the vault, e.g., 0x5732b81e659bd2db47a5b55755743dde15be99490a39717abc80d62ec812bcb6.
    • name, string - name of the vault, e.g., vSUI - SUI.
    • coinAAmount, string - amount of the first coin in the vault, e.g., 1519842349.
    • coinBAmount, string - amount of the second coin in the vault, e.g., 2916547201.
    • coinA, object - detailed information about the first coin.
      • decimals, number - decimal places for the coin, e.g., 9.
      • name, string - full name of the coin, e.g., Volo Staked SUI.
      • symbol, string - ticker symbol of the coin, e.g., vSUI.
      • iconUrl, string - URL to the coin's icon, e.g., https://archive.cetus.zone/assets/image/sui/vsui.png.
    • coinB, object - detailed information about the second coin.
      • decimals, number - decimal places for the coin, e.g., 9.
      • name, string - full name of the coin, e.g., SUI Token.
      • symbol, string - ticker symbol of the coin, e.g., SUI.
      • iconUrl, string - URL to the coin's icon, e.g., https://archive.cetus.zone/assets/image/sui/sui.png.
    • coinTypeA, string - address and type of the first coin, e.g., 0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT.
    • coinTypeB, string - address and type of the second coin, e.g., 0x2::sui::SUI.

FlowX

  • liquidity, array object - list of traditional liquidity positions (V2).
    • poolId, string - unique identifier for the liquidity pool, e.g., 0x26962c11055f880e636f35f51c9b9be9843266d72631a55032c54c4c34ddefaf.
    • coinTypeX, string - address and type of the first coin in the position, e.g., 0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN.
    • coinTypeY, string - address and type of the second coin in the position, e.g., 0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c::coin::COIN.
    • amountX, string - amount of the first coin in the position, e.g., 1272897.
    • amountY, string - amount of the second coin in the position, e.g., 1272619.
    • feeRate, number - fee rate for the pool, e.g., 0.0001 (0.01%).
  • liquidityV3, array object - list of concentrated liquidity positions.
    • isOut, boolean - indicates whether the position is out of range (current tick is outside the position's range), e.g., true.
    • poolId, string - unique identifier for the liquidity pool.
    • coinTypeX, string - address and type of the first coin in the position.
    • coinTypeY, string - address and type of the second coin in the position.
    • amountX, string - amount of the first coin in the position.
    • amountY, string - amount of the second coin in the position.
    • feeReward, array object - list of fee rewards earned.
      • coinType, string - address and type of the reward coin.
      • amount, string - amount of fee rewards earned.
    • incentiveReward, array object - list of incentive rewards earned.
      • coinType, string - address and type of the incentive reward coin.
      • amount, string - amount of incentive rewards earned.
    • feeRate, number - fee rate for the pool.
  • faas, array object - list of farming-as-a-service positions.
    • poolId, string - unique identifier for the farm pool, e.g., 0x387e3aa1f34e261a1f46f6be848d5cf9122dfdaa7cd934880f5a4a47e173e7e7.
    • coinTypeX, string - address and type of the first coin in the position, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • coinTypeY, string - address and type of the second coin in the position, e.g., 0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI.
    • amountX, string - amount of the first coin staked, e.g., 12245223053.
    • amountY, string - amount of the second coin staked, e.g., 11619763312.
    • pendingFLX, string - address and type of the FLX reward coin, e.g., 0x6dae8ca14311574fdfe555524ea48558e3d1360d1607d1c7f98af867e3b7976c::flx::FLX.
    • pendingFLXAmount, string - amount of pending FLX rewards, e.g., 0.
    • pendingToken, string - address and type of the other reward token, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • pendingTokenAmount, string - amount of pending token rewards, e.g., 127553632.

Haedal

  • lps, array object - list of liquidity provider positions.
    • poolId, string - unique identifier for the liquidity pool, e.g., 0x41a4ab1e82f90f5965bbcd828b8ffa13bab7560bd2e352ab067e343db552f527.
    • coinTypeA, string - address and type of the first coin in the position, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
    • coinTypeB, string - address and type of the second coin in the position, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • balanceA, string - amount of the first coin in the position, e.g., 1653848.
    • balanceB, string - amount of the second coin in the position, e.g., 382864839.
  • stakings, array object - list of staking positions.
    • claim_epoch, string - epoch number for claiming rewards, e.g., 712.
    • claim_timestamp_ms, string - timestamp when rewards can be claimed, in milliseconds, e.g., 1742837952915.
    • id, object - identifier information.
      • id, string - unique identifier for the staking position, e.g., 0xfa85276eb438bf04c7457ba423e5da0644e65a23a3e04f23072ddd70c8b0675e.
    • st_amount, string - amount of staked tokens, e.g., 1253000000.
    • sui_amount, string - amount of SUI tokens, e.g., 1317037153.
    • unstake_timestamp_ms, string - timestamp when tokens can be unstaked, in milliseconds, e.g., 1742808990489.

Kai Finance

  • vaults, array object - list of single-asset vault positions.
    • vaultId, string - unique identifier for the vault, e.g., 0x16272b75d880ab944c308d47e91d46b2027f55136ee61b3db99098a926b3973c.
    • coin, object - detailed information about the coin in the vault.
      • p, object - phantom type information for the coin.
        • phantomType, string - type of the coin, e.g., 0x2::sui::SUI.
        • kind, string - kind of the phantom type, e.g., PhantomReified.
      • typeName, string - fully qualified type name of the coin, e.g., 0x2::sui::SUI.
      • decimals, number - decimal places for the coin, e.g., 9 for SUI or 6 for USDC.
      • name, string - full name of the coin, e.g., Sui.
      • description, string - description of the coin.
      • symbol, string - symbol of the coin, e.g., SUI.
      • displaySymbol, string - display symbol of the coin, e.g., SUI.
      • iconUrl, string - URL to the coin's icon, e.g., https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/sui-coin.svg/public.
    • ytBalance, string - yield token balance in the vault, e.g., 0.086999956.
    • equity, string - equity value of the position, e.g., 0.101832435.
    • apy, number - annual percentage yield of the vault, e.g., 0.07544227809653026 (7.54%).
  • lpVaults, array object - list of liquidity provider vault positions.
    • inRange, boolean - indicates whether the LP position is in range, e.g., false.
    • coinA, object - detailed information about the first coin in the LP vault.
      • p, object - phantom type information for the coin.
      • typeName, string - fully qualified type name of the coin, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
      • decimals, number - decimal places for the coin, e.g., 6.
      • name, string - full name of the coin, e.g., USDC.
      • description, string - description of the coin.
      • symbol, string - symbol of the coin, e.g., USDC.
      • displaySymbol, string - display symbol of the coin, e.g., USDC.
      • iconUrl, string - URL to the coin's icon.
    • coinB, object - detailed information about the second coin in the LP vault.
    • positionCapId, string - unique identifier for the LP position, e.g., 0x4e8a91a98e295d671813bee3094ad8b57f45c0f31e200233869485c4cea96f30.
    • balanceA, string - amount of the first coin in the position, e.g., 0.317881.
    • balanceB, string - amount of the second coin in the position, e.g., 0.037290683.

Momentum

  • lps, array object - list of liquidity provider positions.
    • isOut, boolean - indicates whether the position is out of range (current price is outside the position's price range), e.g., true.
    • positionId, string - unique identifier for the position, e.g., 0x123...abc.
    • coinTypeA, string - address and type of the first coin in the position, e.g., 0x2::sui::SUI.
    • coinTypeB, string - address and type of the second coin in the position, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
    • balanceA, string - amount of the first coin in the position, e.g., 1500000000.
    • balanceB, string - amount of the second coin in the position, e.g., 250000.
    • rewards, array object - list of reward tokens earned.
      • coinAddress, string - address of the reward coin.
      • amount, string - amount of rewards earned.
    • fees, object - fees earned from the position.
      • balanceA, string - fees earned in the first coin, e.g., 12345.
      • balanceB, string - fees earned in the second coin, e.g., 6789.

Navi

  • supply, array object - list of assets supplied by the user.
    • coinType, string - address and type of the supplied coin, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • value, number - amount of supplied assets, e.g., 2.155812269.
    • symbol, string - symbol of the supplied coin, e.g., WAL.
    • logo, string - URL to the coin's logo, e.g., https://www.walrus.xyz/wal-icon.svg.
    • apy, string - annual percentage yield for the supplied asset, e.g., 41.327.
  • borrow, array object - list of assets borrowed by the user.
    • coinType, string - address and type of the borrowed coin, e.g., 0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN.
    • value, number - amount of borrowed assets, e.g., 8.3e-8 for WETH.
    • symbol, string - symbol of the borrowed coin, e.g., WETH.
    • logo, string - URL to the coin's logo, e.g., https://imagedelivery.net/cBNDGgkrsEA-b_ixIp9SkQ/weth.jpg/public.
    • apy, string - annual percentage yield (interest rate) for the borrowed asset, e.g., 14.833.
  • rewards, array object - list of rewards (empty array). This feature is temporarily not available due to optimization considerations. Reward information will be provided in future updates.

Scallop

  • totalSupplyValue, number - total value of all supplied assets in USD, e.g., 38.93860583298769.
  • totalDebtValue, number - total value of all borrowed assets in USD, e.g., 0.1025565939623475.
  • totalCollateralValue, number - total value of all collateral assets in USD, e.g., 1.3701739788.
  • totalLockedScaValue, number - total value of locked SCA tokens in USD, e.g., 2.0302826439658213.
  • lendings, array object - list of assets supplied by the user.
    • suppliedCoin, number - amount of supplied coins, e.g., 1.8985705791381289.
    • suppliedValue, number - USD value of supplied coins, e.g., 0.4131151554123465.
    • stakedCoin, number - amount of staked coins, e.g., 0.
    • coinName, string - name of the supplied coin, e.g., deep.
    • symbol, string - symbol of the supplied coin, e.g., DEEP.
    • coinType, string - address and type of the coin, e.g., 0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP.
    • coinPrice, number - current price of the coin in USD, e.g., 0.21759273.
    • coinDecimals, number - decimal places for the coin, e.g., 6.
    • supplyApr, number - annual percentage rate for supplying, e.g., 0.16175131075908375.
    • supplyApy, number - annual percentage yield for supplying, e.g., 0.17552573427319063.
    • incentiveApr, number - additional incentive APR, e.g., 0.
  • borrowings, array object - list of user's borrowing positions.
    • obligationId, string - unique identifier for the borrowing position, e.g., 0x33e76f3d3e6ce20328753afde03f97fd89256db52209e0f8e1bec2dbac56864a.
    • totalDebtsInUsd, number - total borrowed amount in USD, e.g., 0.1025565939623475.
    • totalCollateralInUsd, number - total collateral value in USD, e.g., 0.833464004.
    • riskLevel, number - current risk level of the position, e.g., 0.1447630801895086.
    • availableCollateralInUsd, number - available collateral value in USD, e.g., 0.5642146090824077.
    • totalUnhealthyCollateralInUsd, number - value of unhealthy collateral in USD, e.g., 0.
    • collaterals, array object - list of collateral assets.
      • coinName, string - name of the collateral coin, e.g., sui.
      • symbol, string - symbol of the collateral coin, e.g., SUI.
      • coinDecimals, number - decimal places for the coin, e.g., 9.
      • coinType, string - address and type of the coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
      • coinPrice, number - current price of the coin in USD, e.g., 4.16732002.
      • depositedCoin, number - amount of deposited collateral, e.g., 0.2.
      • depositedValueInUsd, number - USD value of deposited collateral, e.g., 0.833464004.
    • borrowedPools, array object - list of borrowed assets.
      • coinName, string - name of the borrowed coin, e.g., fdusd.
      • symbol, string - symbol of the borrowed coin, e.g., FDUSD.
      • coinDecimals, number - decimal places for the coin, e.g., 6.
      • coinType, string - address and type of the coin, e.g., 0xf16e6b723f242ec745dfd7634ad072c42d5c1d9ac9d62a39c381303eaa57693a::fdusd::FDUSD.
      • coinPrice, number - current price of the coin in USD, e.g., 0.99881761.
      • borrowedCoin, number - amount of borrowed coins, e.g., 0.1026779994020605.
      • borrowedValueInUsd, number - USD value of borrowed coins, e.g., 0.1025565939623475.
      • borrowApr, number - annual percentage rate for borrowing, e.g., 0.09921979596465826.
      • borrowApy, number - annual percentage yield for borrowing, e.g., 0.10429410595542965.
      • incentiveInfos, array object - list of incentives for borrowing.
        • coinName, string - name of the incentive coin, e.g., ssui.
        • symbol, string - symbol of the incentive coin, e.g., sSUI.
        • coinType, string - address and type of the incentive coin, e.g., 0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI.
        • incentiveApr, number - incentive annual percentage rate, e.g., 0.16493784635437356.
  • pendingRewards, object - pending rewards from lending and borrowing.
    • lendings, array object - list of lending rewards.
      • symbol, string - symbol of the reward coin, e.g., SUI.
      • coinType, string - address and type of the reward coin, e.g., 0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
      • coinPrice, number - current price of the reward coin in USD, e.g., 4.16732002.
      • pendingRewardInCoin, number - amount of pending rewards, e.g., 0.010610042.
      • coinName, string - name of the reward coin, e.g., sui.
      • pendingRewardInUsd, number - USD value of pending rewards, e.g., 0.04421544043964084.
    • borrowIncentives, array object - list of borrowing incentives.
      • coinName, string - name of the incentive coin, e.g., ssui.
      • symbol, string - symbol of the incentive coin, e.g., sSUI.
      • coinType, string - address and type of the incentive coin, e.g., 0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI.
      • coinPrice, number - current price of the incentive coin in USD, e.g., 4.453165135472618.
      • pendingRewardInCoin, number - amount of pending incentives, e.g., 0.00211408686372876.
      • pendingRewardInUsd, number - USD value of pending incentives, e.g., 0.009414377914917565.
  • veScas, array object - list of locked SCA tokens for governance.
    • veScaKey, string - unique identifier for the veSCA position, e.g., 0x961aad5a88bb69ebb587979a85cff08e8da285ff4891113816a7fca5cfd21724.
    • coinPrice, number - current price of SCA token in USD, e.g., 0.17104681.
    • lockedScaInCoin, number - amount of locked SCA tokens, e.g., 11.869748661.
    • lockedScaInUsd, number - USD value of locked SCA tokens, e.g., 2.0302826439658213.
    • currentVeScaBalance, number - current veSCA balance, e.g., 0.
    • remainingLockPeriodInDays, number - remaining lock period in days, e.g., 0.
    • unlockAt, number - timestamp when tokens will unlock, in milliseconds, e.g., 1728259200000.

Steamm

  • poolId, string - unique identifier for the liquidity pool, e.g., 0xf5e3f300b55ed12c2d8c50cc2093d74b94ee772e92031670e641ee7b51a36459.
  • coinTypeA, string - address and type of the first coin in the position, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
  • coinTypeB, string - address and type of the second coin in the position, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
  • balanceA, string - amount of the first coin in the position, e.g., 2393982782.
  • balanceB, string - amount of the second coin in the position, e.g., 1560954.

Suilend

  • deposits, array object - list of assets deposited by the user.
    • coinType, string
    • decimals, number
    • symbol, string
    • iconUrl, string - URL to the coin's icon (URL or empty string).
    • amount, string
  • borrows, array object - list of assets borrowed by the user.
    • coinType, string
    • decimals, number
    • symbol, string
    • iconUrl, string - URL to the coin's icon (URL or empty string).
    • amount, string
  • strategies, array object - list of strategies
    • poolId, string
    • coinType, string Reserve coin type.
    • amount, string
    • decimals, number
    • iconUrl,string - URL to the coin's icon (URL or empty string).
    • coinTypes, string[] - strategy coin pair.
    • type , string strategy type.

Turbos

  • lps, array object - list of liquidity provider positions.
    • isOut, boolean - indicates whether the position is out of range (current tick is outside the position's range), e.g., true.
    • poolId, string - unique identifier for the liquidity pool, e.g., 0x9490a13351e13b133bd8a9c309c47568d6fcbfcbfe7aac0e228b710053583081.
    • positionId, string - unique identifier for the position, e.g., 0xc425c73eec5014b2ea51f28ef6e2a0f52c97c4e3b7cc11e54deafdda3bf46d0d.
    • coinTypeA, string - address and type of the first coin in the position, e.g., 0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL.
    • balanceA, string - amount of the first coin in the position, e.g., 0.
    • coinTypeB, string - address and type of the second coin in the position, e.g., 0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC.
    • balanceB, string - amount of the second coin in the position, e.g., 2260658.
    • collectFees, object - (deprecated) uncollected fees earned by the position.
      • feeOwedA, string - uncollected fees in the first coin, e.g., 11445149.
      • feeOwedB, string - uncollected fees in the second coin, e.g., 6598.
    • fees, object - accumulated fees earned by the position.
      • balanceA, string - fees earned in the first coin, e.g., 11445149.
      • balanceB, string - fees earned in the second coin, e.g., 6598.
    • rewards, array object - list of reward tokens earned.
      • coinType, string - address and type of the reward coin, e.g., 0x2::sui::SUI.
      • amount, string - amount of reward tokens earned, e.g., 2847299.
  • vaults, array object - list of vault positions.
    • vaultId, string - unique identifier for the vault.
    • positionId, string - identifier for the associated position.
    • coinTypeA, string - address and type of the first coin in the vault.
    • coinTypeB, string - address and type of the second coin in the vault.
    • balanceA, string - total amount of the first coin in the vault (sum of base, limit, and vault balances).
    • balanceB, string - total amount of the second coin in the vault (sum of base, limit, and vault balances).

Typus Finance

  • depositRes, array object - list of deposit positions from Typus DOV (Decentralized Option Vault).
    • vault, string - name of the vault strategy, e.g., SUI-Weekly-Call or NAVX-Hourly-CappedCall.
    • balance, number - amount of user's deposit in the vault, e.g., 4.240927787.
    • depositAsset, string - asset name of the deposited token, e.g., SUI.
    • depositToken, string - address and type of the deposited token, e.g., 0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • rewards, number - total rewards earned from the vault, e.g., 1.127184004.
    • rewardsAsset, string - asset name of the reward token, e.g., SUI.
    • rewardsToken, string - address and type of the reward token, e.g., 0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
  • rebateRes, array object - list of rebates earned by the user.
    • token, string - address and type of the rebate token, e.g., 0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • asset, string - asset name of the rebate token, e.g., SUI.
    • amount, number - amount of rebates earned, e.g., 0.001336095.
    • decimal, number - decimal places for the token, e.g., 9.
  • userBids, array object - list of user's active bids in auctions (empty in this example).
  • userSAFU, array object - list of positions in Typus SAFU (Secure Asset Fund for Users) vaults.
    • vault, string - name of the vault, e.g., SUI Daily Bull or Daily All Weather.
    • balance, number - amount of user's deposit in the vault, e.g., 10.373441031.
    • token, string - asset name of the deposited token, e.g., SUI.
    • coinType, string - address and type of the deposited token, e.g., 0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
    • rewards, array object - list of rewards earned from the vault.
      • token, string - asset name of the reward token, e.g., SUI.
      • coinType, string - address and type of the reward token, e.g., 0000000000000000000000000000000000000000000000000000000000000002::sui::SUI.
      • reward, number - amount of rewards earned, e.g., 0.185173835.

Magma

  • clmm,array object
    • isOut, bool - indicates whether the position is out of range
    • poolId, string
    • positionId, string
    • coinTypeA, string
    • coinTypeB, string
    • amountA, string
    • amountB, string
    • apr, string - total apr.
    • fees,object
      • feeOwedA, string
      • feeOwedB, string
    • rewards, array object
      • coinType, string
      • amount, string
  • almm,array object
    • isOut, bool - indicates whether the position is out of range
    • poolId, string
    • positionId, string
    • coinTypeA, string
    • coinTypeB, string
    • amountA, string
    • amountB, string
    • apr, string - total apr.
    • fees,object
      • feeOwedA, string
      • feeOwedB, string
    • rewards, object
      • rewards, string[]
      • amount, string[]

Ferra

  • dlmm, array object
    • positionId, string
    • pairId, string
    • coinTypeX, string
    • coinTypeY, string
    • amountX, string
    • amountY, string
    • apr, number , e.g., 168.95987712492962
    • inRange, boolean - indicates whether the position is in range
  • clmm, array object
    • positionId, string
    • pairId, string
    • coinTypeX, string
    • coinTypeY, string
    • amountX, string
    • amountY, string
    • feeX, string
    • feeY, string
    • apr, number , e.g., 4.293527953632222
    • inRange, boolean - indicates whether the position is in range

SuiNS Staking

  • stakings, array object
    • amount, string
    • lockUntil, number, e.g., 1760164261209

Deepbook

  • deposits,array object - deepbook margin positions
    • amount, string
    • coinType, string
Query Params
string
required

account address

string
enum
required
Defaults to navi

DeFi protocol (eg "cetus" or "navi").

Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago