get https://api-pro.sim.hashkeydev.com/api/v1/account/balanceFlow
- Only master account Master API key can call this interface, sub-accounts will return insufficient privilege type error code
- All orders returned are final
- Deposit, Withdrawal failed will not be returned
- Query of trade history supports the past 14 days time range(though the endpoint support up to get 7 days data for each request). The other types support maximum 30 days. Exceeded amount will return error code "Exceed maximum time range of N days"
- Remark can only support up to 128 characters
Please note the current endpoint is available to our Institutional clients only and can be requested by case by case
Weight: 3
Request Parameters
PARAMETER | TYPE | Req'd | DESCRIPTION |
---|---|---|---|
accountId | LONG | Account ID | |
type | STRING | Y | Transaction type: "trade" "deposit" "fiatDeposit" "withdraw" "fiatWithdraw" "transfer" |
clientOrderId | STRING | Corresponds to types: "trade", "fiatWithdraw", "transfer" | |
remark | STRING | Remark | |
startTime | LONG | Y | Start timestamp |
endTime | LONG | Y | End timestamp |
beginId | INT | Start record number. Default: 0 E.g. If input ID is 1, return starting ID as 2 | |
limit | INT | Limit | |
recvWindow | LONG | Recv window | |
timestamp | LONG | Y | Timestamp |
Type = trade
Supported for the past 7 days time range
Response content
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
id | STRING | Record ID |
accountId | STRING | Account ID |
type | STRING | "trade" |
netBaseAmount | STRING | Order Quantity Default Value ="" Buy direction (+ve) Sell direction (-ve) |
baseCcy | STRING | Base currency |
baseAssetBalance | STRING | Base asset balance Default Value ="" |
netQuoteAmount | STRING | Price * Quantity Default Value ="" Buy direction (-ve) Sell direction (+ve) |
quoteAssetBalance | STRING | Quote asset balance Default Value ="" |
quoteCcy | STRING | E.g. USDT, USDC, USD |
direction | STRING | BUY or SELL |
fee | STRING | Trading fee Default Value = 0 |
feeCcy | STRING | E.g. BTC, ETH, USDC |
clientOrderId | STRING | Client order ID |
orderId | STRING | Order ID |
tradeId | STRING | Trade ID |
transactTime | STRING | Trade completed time |
Sample
[
{
"id": "47049",
"accountId": "1617382306753847296",
"type": "trade",
"netBaseAmount": "0.00015",
"baseCcy": "BTC",
"baseAssetBalance": "96.53346265",
"netQuoteAmount": "-9.622275",
"quoteCcy": "USDC",
"quoteAssetBalance": "887623.4732212",
"direction": "BUY",
"fee": "0.000000225",
"feeCcy": "BTC",
"clientOrderId": "99999999980097",
"orderId": "1733373323360866560",
"tradeId": "1733373323528638720",
"transactTime": "1721370202000" //Trade Completed time
},
{
"id": "47050",
"accountId": "1617382306753847296",
"type": "trade",
"netBaseAmount": "0.29951",
"baseCcy": "BTC",
"baseAssetBalance": "96.83297265",
"netQuoteAmount": "-9984.7019729",
"quoteCcy": "USD",
"quoteAssetBalance": "679.337974140649999999",
"direction": "BUY",
"fee": "14.97705295935",
"feeCcy": "USD",
"clientOrderId": "99999999980098",
"orderId": "1733374982912741632",
"tradeId": "1733374983021793536",
"transactTime": "1721370400000" //Trade Completed time
}
]
Type = fiatDeposit/fiatWithdraw
Supported for the past 30 days time range
Response content
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
id | STRING | Record ID |
accountId | STRING | Account ID |
type | STRING | "fiatDeposit", "fiatWithdraw" |
netFiatAmount | STRING | Fiat Deposit/Withdraw: amount Default Value = 0 |
fiatCcy | STRING | E.g. HKD, USD |
fiatBalance | STRING | Fiat balance in the account Default Value = 0 |
fee | STRING | Fee amount |
feeCcy | STRING | Fee Currency |
orderId | STRING | Fiat Order ID |
remark | STRING | Remark |
transactTime | STRING | Fiat Deposit/Withdraw Completed Time |
Sample
[
{
"id": "3",
"accountId": "1491920242963768578",
"type": "fiatDeposit",
"netFiatAmount": "100001",
"fiatCcy": "USD",
"fiatBalance": "897400",
"fee": "0",
"feeCcy": "USD",
"orderId": "FD486905037302665216",
"remark": "",
"transactTime": "1693895601000"
},
{
"id": "1",
"accountId": "1491920242963768578",
"type": "fiatWithdraw",
"netFiatAmount": "50001",
"fiatCcy": "USD",
"fiatBalance": "797399",
"fee": "0",
"feeCcy": "USD",
"orderId": "FW486905166923436032",
"remark": "",
"transactTime": "1693895424000"
}
]
Type = deposit/withdraw
Supported for the past 30 days time range
Response content
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
id | STRING | Record ID |
accountId | STRING | Account ID |
type | STRING | "Deposit", "Withdraw" |
netVaAmount | STRING | Deposit/Withdraw: amount Default Value = 0 |
vaCcy | STRING | ETH, BTC, USDC, etc |
vaBalance | STRING | Fiat balance in the account Default Value = 0 |
fee | STRING | Deposit/Withdraw Fee Default Value = 0 |
feeCcy | STRING | Fee Currency |
orderId | STRING | Deposit/Withdraw Order ID |
txnId | STRING | Chain Transaction ID |
remark | STRING | Remark |
transactTime | STRING | Deposit/Withdraw Completed Time |
Sample
[
{
"id": "1",
"accountId": "1491920242963768577",
"type": "Deposit",
"netVaAmount": "0.01",
"vaCcy": "ETH",
"vaBalance": "0.01",
"fee": "0",
"feeCcy": "ETH",
"orderId": "D486914664762015744",
"txnId": "0xc018245e58832271207160506fb8c405e1d0447f612755eaaa08ce5169a8cb64",
"remark": "1234",
"transactTime": "1693897504000"
},
{
"id": "5",
"accountId": "1491920242963768577",
"type": "Withdraw",
"netVaAmount": "0.01",
"vaCcy": "ETH",
"vaBalance": "0.03",
"fee": "0",
"feeCcy": "ETH",
"orderId": "W486916336670310400",
"txnId": "0xad87ba9b35daac48c5fbc2388b3232d611177c53b73b4e1bae5c1565c38d0024",
"remark": "1234",
"transactTime": "1693898225000"
}
]
Type = transfer
Supported for the past 30 days time range
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
id | STRING | Record ID |
fromAccountId | STRING | From Account ID |
toAccountId | STRING | To Account ID |
type | STRING | "transfer" |
netTransferAmount | STRING | Transfer Amount Default Value = 0 |
transferCcy | STRING | ETH, BTC, USDC, etc |
fromAccountBalance | STRING | From Account balance Default Value = 0 |
toAccountBalance | STRING | To Account balance Default Value = 0 |
orderId | STRING | Transfer OrderID |
remark | STRING | Remark |
transactTime | STRING | Transfer Completed Time |
[
{
"id": "1",
"fromAccountId": "1491920242963768578",
"toAccountId": "1491920242963768576",
"type": "transfer",
"netTransferAmount": "10000",
"transferCcy": "USD",
"fromAccountBalance": "987400",
"toAccountBalance": "111559.9813547",
"orderId": "1502924239170215680", // Transfer order ID
"remark": "",
"transactTime": "1693898531000"
},
{
"id": "2",
"fromAccountId": "1491920242963768577",
"toAccountId": "1491920242963768576",
"type": "transfer",
"netTransferAmount": "0.01",
"transferCcy": "ETH",
"fromAccountBalance": "0.02",
"toAccountBalance": "0.0308",
"orderId": "1502924310800539392", // Transfer order ID
"remark": "",
"transactTime": "1693898539000"
}
]