Parameters
- objectobjectREQUIRED
The wallet token balance request object with the following fields:
- walletstringREQUIRED
The wallet address or ENS name to check for ERC-20 tokens.
- contractsarray
An array with the list of ERC-20 contract addresses to filter wallet balance results on. You may include up to 100 contract addresses per request.
- pageinteger
The page number you would like returned. The page numbers start at 1 and end at totalPages. If omitted, defaults to the first page (page 1). If the page number requested is higher than totalPages, an empty transfers array will be returned. If the page number requested is less than 1, an invalid params response will be returned.
- perPageinteger
The maximum amount of tokens to return on each page. You can request up to 100 items per page. If omitted, defaults to 20 items per page.
Returns
- objectobject
The custom response object, or null if no tokens are found:
- addressstring
The address we checked for ERC-20 tokens.
- ensNamestring
The ENS name associated with the address we checked.
- resultarray
An array of objects representing tokens with the following shape:
- quantityInstring
The total amount of tokens that have been transferred into the wallet.
- quantity_instring
The total amount of tokens that have been transferred into the wallet.
- quantityOutstring
The total amount of tokens that have been transferred out of the wallet.
- quantity_outstring
The total amount of tokens that have been transferred out of the wallet.
- addressstring
The address of the ERC-20 token contract.
- namestring
The name of the token.
- decimalsstring
The number of decimal places supported by the token contract.
- symbolstring
The symbol of the token.
- totalBalancestring
The balance of the token within the owner's wallet.
- total_balancestring
The token balance within the owner's wallet.
- nativeTokenBalancestring
The balance of the native token within the owner's wallet.
- totalPagesinteger
The total number of results pages available.
- pageNumberinteger
The page number of results that was returned with this response.
- totalItemsinteger
The total number of results.
1{2"jsonrpc": "2.0",3"id": 67,4"result": {5"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",6"ensName": "vitalik.eth",7"result": [8{9"name": "USD Coin",10"symbol": "USDC",11"decimals": "6",12"address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",13"quantityIn": "3196941437801",14"quantityOut": "3192810447159",15"totalBalance": "4130990642",16"quantity_in": "3196941437801",17"quantity_out": "3192810447159",18"total_balance": "4130990642"19},20{21"name": "Tether USD",22"symbol": "USDT",23"decimals": "6",24"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",25"quantityIn": "101379287975",26"quantityOut": "101110107635",27"totalBalance": "269180340",28"quantity_in": "101379287975",29"quantity_out": "101110107635",30"total_balance": "269180340"31}32],33"nativeTokenBalance": "33.111612880018143614",34"totalItems": 2,35"totalPages": 1,36"pageNumber": 137}38}
1{2"jsonrpc": "2.0",3"id": 67,4"result": {5"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",6"ensName": "vitalik.eth",7"result": [8{9"name": "USD Coin",10"symbol": "USDC",11"decimals": "6",12"address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",13"quantityIn": "3196941437801",14"quantityOut": "3192810447159",15"totalBalance": "4130990642",16"quantity_in": "3196941437801",17"quantity_out": "3192810447159",18"total_balance": "4130990642"19},20{21"name": "Tether USD",22"symbol": "USDT",23"decimals": "6",24"address": "0xdac17f958d2ee523a2206206994597c13d831ec7",25"quantityIn": "101379287975",26"quantityOut": "101110107635",27"totalBalance": "269180340",28"quantity_in": "101379287975",29"quantity_out": "101110107635",30"total_balance": "269180340"31}32],33"nativeTokenBalance": "33.111612880018143614",34"totalItems": 2,35"totalPages": 1,36"pageNumber": 137}38}