API Reference

Change log

2024-06-28

Withdraw now supports Exchange platform

  • [POST] /api/v1/account/withdraw added "platform" request parameters
PARAMETERTYPEReq'dExample valuesDESCRIPTION
platformSTRINGBinanceNetwork name
  • [GET] /api/v1/account/withdrawOrders added "platform" response content
PARAMETERTYPEExample valuesDESCRIPTION
platformSTRINGBinanceNetwork name

2024-06-19

  • Added Perpetual Futures Guide and FAQ
  • Futures Trading endpoint is now LIVE

2024-06-03

Introduced new endpoint for Liquidation orders for Market Makers

  1. Get Liquidation assign status [GET] /api/v1/futures/liquidationAssignStatus to check assignment status and requirements
  2. New Response content Query Futures history orders [GET] /api/v1/futures/historyOrders
PARAMETERTYPEExample valuesDESCRIPTION
isLiquidationOrderBOOLEANtrueWhether the order is a liquidation order
liquidationTypeSTRING"LIQUIDATION_MAKER_ADL", "LIQUIDATION_MAKER", "LIQUIDATION_TAKER". Available when isLiquidationOrder is true
indexPriceSTRINGIndex price. Available when isLiquidationOrder is true
  1. New Response content Get Sub Account Futures History Orders [GET] /api/v1/futures/subAccount/historyOrders
PARAMETERTYPEExample valuesDESCRIPTION
isLiquidationOrderBOOLEANtrueWhether the order is a liquidation order
liquidationTypeSTRING"LIQUIDATION_MAKER_ADL", "LIQUIDATION_MAKER", "LIQUIDATION_TAKER". Available when isLiquidationOrder is true
  1. New field contractExecutionReport websocket feed
PARAMETERTYPEDESCRIPTION
PSTRINGIndex Price
loBOOLEANWhether the order is a liquidation order
ltSTRING"LIQUIDATION_MAKER_ADL", "LIQUIDATION_MAKER", "LIQUIDATION_TAKER",

2024-04-30

Introduced new endpoints for Futures trading for Beta testing in sandbox environment

  1. Change Futures leverage [POST] /api/v1/futures/leverage
  2. Query Futures leverage [GET] /api/v1/futures/leverage
  3. Create new Futures order [POST] /api/v1/futures/order
  4. Set trading stop [POST] /api/v1/futures/position/trading-stop
  5. Batch create new Futures order [POST] /api/v1/futures/batchOrders
  6. Cancel Futures order [DELETE] /api/v1/futures/order
  7. Batch cancel Futures order [DELETE] /api/v1/futures/batchOrders
  8. Batch cancel Futures order by order id [DELETE] /api/v1/futures/cancelOrderByIds
  9. Get Futures order [GET] /api/v1/futures/order
  10. Query open Futures orders [GET] /api/v1/futures/openOrders
  11. Query Futures trades [GET] /api/v1/futures/userTrades
  12. Get Futures positions [GET] /api/v1/futures/positions
  13. Query Futures history orders [GET] /api/v1/futures/historyOrders
  14. Get Futures account balance [GET] /api/v1/futures/balance
  15. Get Futures funding rate [GET] /api/v1/futures/fundingRate
  16. Get Futures history funding rate [GET] /api/v1/futures/historyFundingRate
  17. Query Futures risk limit [GET] /api/v1/futures/riskLimit
  18. Get Futures commission rate [GET] /api/v1/futures/commissionRate
  19. Get Futures best order [GET] /api/v1/futures/getBestOrder
  20. Get Mark Price [GET] /quote/v1/markPrice
  21. Get Index Price [GET] /quote/v1/index
  22. Get Sub Account Futures Open Orders[GET] /api/v1/futures/subAccount/openOrders
  23. Get Sub Account Futures History Orders[GET] /api/v1/futures/subAccount/historyOrders
  24. Get Sub Account Futures trades [GET] /api/v1/futures/subAccount/userTrades

Added new websocket push feed

  • New Future account balance change. Event type: outboundContractAccountInfo
  • New Future account order update. Event type: contractExecutionReport

2024-04-05


In order to improve system performance and optimise user experience, HashKey will update the most optimal limit and require user to insert mandatory fields for querying our data. Please finish the adjustment as soon as possible.

[DELETE]/api/v1/spot/openOrders endpoint

  • Updated upper limit of 200 orders
  • Updated Request parameters "symbol" to required
PARAMETERTYPEReq'dExample valuesDESCRIPTION
symbolSTRINGYBTCUSDCCurrency pair name (separated by multiple ,)

[GET] /api/v1/spot/openOrders endpoint

  • Updated field name "orderId" to "fromOrderId"
PARAMETERTYPEReq'dExample valuesDESCRIPTION
fromOrderIdLONG1470930457684189696Order ID

[GET] /api/v1/spot/tradeOrders endpoint

  • Updated field name "orderId" to "fromOrderId"
PARAMETERTYPEReq'dExample valuesDESCRIPTION
fromOrderIdLONG1470930457684189696Order ID

Newly added endpoint

  • Query Sub-account Open Orders [GET] /api/v1/spot/subAccount/openOrders
  • Query Sub-account Trade Orders [GET] /api/v1/spot/subAccount/tradeOrders
  • Get Account Trade List [GET] /api/v1/subAccount/trades
  • Authenticate Deposit [POST] /api/v1/account/authAddress