POST
/
v0
/
generic
/
balance
/
get
curl --request POST \
  --url https://api.compasslabs.ai/v0/generic/balance/get \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "user": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
  "token": "USDC"
}'
{
  "amount": 1.5,
  "decimals": 18,
  "token_symbol": "WETH",
  "token_address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
}

Authorizations

​
x-api-key
string
header
required

Your Compass API key. Get your key here.

Body

application/json

Request model for getting an ERC20 token balance.

​
chain
enum<string>
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
user
string
required

The user to get the ERC20 balance of.

Example:

"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45"

​
token
enum<string>
required

The symbol of the token for which the balance is checked. Note the supported tokens per chain.

Available options:
1INCH,
AAVE,
BAL,
cbBTC,
cbETH,
CRV,
crvUSD,
DAI,
ENS,
ETHx,
FRAX,
FXS,
GHO,
KNC,
LDO,
LINK,
LUSD,
MKR,
osETH,
PYUSD,
rETH,
RPL,
rsETH,
sDAI,
SNX,
STG,
sUSDe,
tBTC,
UNI,
USDC,
USDe,
USDS,
USDT,
WBTC,
weETH,
WETH,
wstETH,
ARB,
EURS,
MAI,
USDCe,
AERO,
EUR,
VIRTUAL

Response

200
application/json
Successful Response

Response model for token balance information.

​
amount
string
required

Amount of tokens a particular address holds

Example:

1.5

​
decimals
integer
required

Number of decimals of the token

Example:

18

​
token_symbol
enum<string>
required

Symbol of the token Note the supported tokens per chain.

Available options:
1INCH,
AAVE,
BAL,
cbBTC,
cbETH,
CRV,
crvUSD,
DAI,
ENS,
ETHx,
FRAX,
FXS,
GHO,
KNC,
LDO,
LINK,
LUSD,
MKR,
osETH,
PYUSD,
rETH,
RPL,
rsETH,
sDAI,
SNX,
STG,
sUSDe,
tBTC,
UNI,
USDC,
USDe,
USDS,
USDT,
WBTC,
weETH,
WETH,
wstETH,
ARB,
EURS,
MAI,
USDCe,
AERO,
EUR,
VIRTUAL
​
token_address
string
required

Address of the token

Example:

"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"

Was this page helpful?