API Reference

Get Fund Statement (Institutional clients only)

  • 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

PARAMETERTYPEReq'dDESCRIPTION
accountIdLONGAccount ID
typeSTRINGYTransaction type:
"trade"
"deposit"
"fiatDeposit"
"withdraw"
"fiatWithdraw"
"transfer"
clientOrderIdSTRINGCorresponds to types: "trade", "fiatWithdraw", "transfer"
remarkSTRINGRemark
startTimeLONGYStart timestamp
endTimeLONGYEnd timestamp
beginIdINTStart record number. Default: 0
E.g. If input ID is 1, return starting ID as 2
limitINTLimit
recvWindowLONGRecv window
timestampLONGYTimestamp

Type = trade

Supported for the past 7 days time range

Response content

PARAMETERTYPEDESCRIPTION
idSTRINGRecord ID
accountIdSTRINGAccount ID
typeSTRING"trade"
netBaseAmountSTRINGOrder Quantity
Default Value =""
Buy direction (+ve)
Sell direction (-ve)
baseCcySTRINGBase currency
baseAssetBalanceSTRINGBase asset balance
Default Value =""
netQuoteAmountSTRINGPrice * Quantity
Default Value =""
Buy direction (-ve)
Sell direction (+ve)
quoteAssetBalanceSTRINGQuote asset balance
Default Value =""
quoteCcySTRINGE.g. USDT, USDC, USD
directionSTRINGBUY or SELL
feeSTRINGTrading fee
Default Value = 0
feeCcySTRINGE.g. BTC, ETH, USDC
clientOrderIdSTRINGClient order ID
orderIdSTRINGOrder ID
tradeIdSTRINGTrade ID
transactTimeSTRINGTrade 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

PARAMETERTYPEDESCRIPTION
idSTRINGRecord ID
accountIdSTRINGAccount ID
typeSTRING"fiatDeposit", "fiatWithdraw"
netFiatAmountSTRINGFiat Deposit/Withdraw: amount
Default Value = 0
fiatCcySTRINGE.g. HKD, USD
fiatBalanceSTRINGFiat balance in the account
Default Value = 0
feeSTRINGFee amount
feeCcySTRINGFee Currency
orderIdSTRINGFiat Order ID
remarkSTRINGRemark
transactTimeSTRINGFiat 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

PARAMETERTYPEDESCRIPTION
idSTRINGRecord ID
accountIdSTRINGAccount ID
typeSTRING"Deposit", "Withdraw"
netVaAmountSTRINGDeposit/Withdraw: amount
Default Value = 0
vaCcySTRINGETH, BTC, USDC, etc
vaBalanceSTRINGFiat balance in the account
Default Value = 0
feeSTRINGDeposit/Withdraw Fee
Default Value = 0
feeCcySTRINGFee Currency
orderIdSTRINGDeposit/Withdraw Order ID
txnIdSTRINGChain Transaction ID
remarkSTRINGRemark
transactTimeSTRINGDeposit/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

PARAMETERTYPEDESCRIPTION
idSTRINGRecord ID
fromAccountIdSTRINGFrom Account ID
toAccountIdSTRINGTo Account ID
typeSTRING"transfer"
netTransferAmountSTRINGTransfer Amount
Default Value = 0
transferCcySTRINGETH, BTC, USDC, etc
fromAccountBalanceSTRINGFrom Account balance
Default Value = 0
toAccountBalanceSTRINGTo Account balance
Default Value = 0
orderIdSTRINGTransfer OrderID
remarkSTRINGRemark
transactTimeSTRINGTransfer 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"
    }
]
Language
Credentials
Header
Click Try It! to start a request and see the response here!