Get user onchain withdrawal history

Rate limit: 5 every second

API Overview

HTTP method

GET

Path

/api/v3/user/withdrawals

Summary

Get user onchain withdrawal history.

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 Account ID, some hash query APIs doesnt need it if in hash query mode, check require flag of each API to see if its a must. 1
start integer N Start time in milliseconds
Default : 0L		 1578558098000
end integer N End time in milliseconds
Default : 0L		 1578558098000
status string N Comma separated status values
Allowable : ['processing', 'processed', 'received', 'failed']		 "processing,p
rocessed"
limit integer N Number of records to return 50
tokenSymbol string N Token to filter. If you want to return deposit records for all tokens, omit this parameter "LRC"
offset integer N Number of records to skip
Default : 0L		 1
withdrawalTypes string N request.getUserTxs.withdrawalTypes
Allowable : ['force_withdrawal', 'offchain_withdrawal']		 "force_withdr
awal"
hashes string N The hashes (split by ,) of the transactions, normally its L2 tx hash, except the deposit which uses L1 tx hash. "0xf7c9323511
86c3a9053f31
3eefa16209c0
18f7f1dba8aa
8ca7100400f7
c31085"

Request example

HTTP
CURL
GET https://api3.loopring.io/api/v3/user/withdrawals?accountId=1&start=1578558098000&end=1578558098000&status=processing,processed&limit=50&tokenSymbol=LRC&offset=1&withdrawalTypes=force_withdrawal&hashes=0xf7c932351186c3a9053f313eefa16209c018f7f1dba8aa8ca7100400f7c31085 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/withdrawals\?accountId\=1\&start\=1578558098000\&end\=1578558098000\&status\=processing,processed\&limit\=50\&tokenSymbol\=LRC\&offset\=1\&withdrawalTypes\=force_withdrawal\&hashes\=0xf7c932351186c3a9053f313eefa16209c018f7f1dba8aa8ca7100400f7c31085

Response fields

Field Type Required Description Example
totalNum integer Y Total number of records found 1
transactions List[Withdrawal
Data]		 Y List of OnchainWithdrawalRecord /

Response example

{
  "totalNum" : 1,
  "transactions" : [
    {
      "id" : 1,
      "txType" : "FORCE_WITHDRAWAL",
      "hash" : "0x9d114267e8b261457d567093c13cf3deea5f14c9235be26c6fa833dba12a9632",
      "symbol" : "LRC",
      "amount" : "1000000000000000000",
      "txHash" : "0x9d114267e8b261457d567093c13cf3deea5f14c9235be26c6fa833dba12a9632",
      "feeTokenSymbol" : "ETH",
      "feeAmount" : "1000000000000000",
      "status" : "processing",
      "progress" : "100%",
      "timestamp" : 1578572292000,
      "blockNum" : 100,
      "updatedAt" : 1578572292000,
      "distributeHash" : "0x9d114267e8b261457d567093c13cf3deea5f14c9235be26c6fa833dba12a9632",
      "requestId" : 1,
      "fastStatus" : "EMPTY",
      "blockId" : integer,
      "indexInBlock" : integer
    }
  ]
}

Status code

Value Description
100000 Unknown error
107001 User ID cannot be empty
104001 Empty ApiKey
104002 Invalid ApiKey
104003 Invalid Account ID

Model

WithdrawalData

Response data

Field Type Required Description Example
id integer Y Unique ID 1
txType string Y User transaction type "FORCE_WITHDR
AWAL"
hash string Y hash "0x9d114267e8
b261457d5670
93c13cf3deea
5f14c9235be2
6c6fa833dba1
2a9632"
symbol string Y Token symbol "LRC"
amount string Y Amount requested by the user "100000000000
0000000"
txHash string Y Transaction hash "0x9d114267e8
b261457d5670
93c13cf3deea
5f14c9235be2
6c6fa833dba1
2a9632"
feeTokenSymbol string Y Fee token symbol "ETH"
feeAmount string Y Fee amount in wei "100000000000
0000"
status string Y Current status
Allowable : ['processing', 'processed', 'received', 'failed']		 "processing"
progress string Y Progress "100%"
timestamp integer Y Create time 1578572292000
blockNum integer Y Block height 100
updatedAt integer Y Update time 1578572292000
distributeHash string Y Distribute Hash "0x9d114267e8
b261457d5670
93c13cf3deea
5f14c9235be2
6c6fa833dba1
2a9632"
requestId integer N Request Id 1
fastStatus string N Fast withdrawal status
Allowable : ['EMPTY', 'PROCEEING', 'SUCCESSED', 'FAILED']		 "EMPTY"
blockId integer Y /
indexInBlock integer Y /

results matching ""

    No results matching ""