GET /api/v3/user/balances
Field | Description | Example | Type | Required |
---|---|---|---|---|
X-API-KEY | ApiKey, can use a valid apiKey to get other address asset | "HlkcGxbqBeaF76j4rvPaOasyfPwnkQ6B6DQ6THZWbvrAGxzEdulXQvOKLrRWZLnN" | string | Y |
Field | Description | Example | Type | Required |
---|---|---|---|---|
accountId | (Optional) AccountID, accountId or address is required | 123456 | integer | Y |
address | (Optional) Address, accountId or address is required | "0x8656920c85342d646E5286Cb841F90209272ABeb" | ||
tokens | (Optional) token ids in exchange tokens | "0,1" | string | N |
Field | Description | Example | Type | Required |
---|---|---|---|---|
accountId | Account ID | 10110 | ||
tokenId | Token ID | 10 | integer | Y |
total | Amount of the asset | "100" | string | Y |
locked | The part of the total balance which is currently not liquid and not at the users disposal (because of pending withdrawals or orders for example) | "100" | string | Y |
pending | Users pending balances | Pending Balance | Y |
Field | Description | Example | Type | Required |
---|---|---|---|---|
withdraw | Withdrawal pending balance which means the token is in withdrawal state but has not arrived at L1 | "100000000000 00" | string | Y |
deposit | Deposit pending balance which means the token is in deposit state but has not arrived at L2 | "100000000000 00" | string | Y |