Skip to content

Latest commit

 

History

History
33 lines (16 loc) · 2.53 KB

File metadata and controls

33 lines (16 loc) · 2.53 KB

Get Assets

EndPoint

GET /api/v3/user/balances

Header

FieldDescriptionExampleTypeRequired
X-API-KEYApiKey, can use a valid apiKey to get other address asset"HlkcGxbqBeaF76j4rvPaOasyfPwnkQ6B6DQ6THZWbvrAGxzEdulXQvOKLrRWZLnN"stringY


Request

FieldDescriptionExampleTypeRequired
accountId(Optional) AccountID, accountId or address is required123456integerY
address(Optional) Address, accountId or address is required"0x8656920c85342d646E5286Cb841F90209272ABeb"
tokens(Optional) token ids in
exchange tokens
"0,1"stringN

Response

FieldDescriptionExampleTypeRequired
accountIdAccount ID10110
tokenIdToken ID10integerY
totalAmount of the asset"100"stringY
lockedThe 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"stringY
pendingUsers pending balancesPending
Balance
Y

Model

PendingBalance

FieldDescriptionExampleTypeRequired
withdrawWithdrawal pending balance which means the token is in withdrawal state but has not arrived at L1"100000000000
00"
stringY
depositDeposit pending balance which means the token is in deposit state but has not arrived at L2"100000000000
00"
stringY