Get user exchange balances

Rate limit: every seconds

API Overview


HTTP method

GET

Path

/api/v3/user/balances

Summary

"Returns user's Ether and token balances on exchange."

API description


HTTP Header

Field Type Required Description Example
X-API-KEY string Y ApiKey "HlkcGxbqBeaF76j4rvPaOasyfPwnkQ
6B6DQ6THZWbvrAGxzEdulXQvOKLrRW
ZLnN"

Request parameters

Field Type Required Description Example
accountId integer Y AccountID 1
tokens string N Query tokens "0,1"

Request example

HTTP
CURL
GET https://api3.loopring.io/api/v3/user/balances?accountId=1&tokens=0,1 HTTP/1.1
Host: api3.loopring.io
Connection: keep-alive
Accept: */*
Accept-Encoding: gzip, deflate, br
Accept-Language: zh,en;q=0.9
X-API-KEY: sra1aavfa
curl -H "X-API-KEY:sra1aavfa" https://api3.loopring.io/api/v3/user/balances\?accountId\=1\&tokens\=0,1

Response fields

Field Type Required Description Example
tokenId integer Y Token ID 10
total string Y Amount of the asset "100"
locked string Y 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"
pending Pending
Balance
Y Users pending balances "100"

Response example

{
  "tokenId" : 10,
  "total" : "100",
  "locked" : "100",
  "pending" : {
    "withdraw" : "10000000000000",
    "deposit" : "10000000000000"
  }
}

Status code

Value Description
100000 Unknown error
104001 Empty ApiKey
104002 Invalid ApiKey
104003 Invalid Account ID

Model


PendingBalance

Users pending balances

Field Type Required Description Example
withdraw string Y Withdrawal pending balance which means the token is in withdrawal state but not arrived L1 "100000000000
00"
deposit string Y Deposit pending balance which means the token is in deposit state but not arrived L2 "100000000000
00"

results matching ""

    No results matching ""