API Reference

Private Steam

Access URL

listenKey can be obtained from Create a Listen Key

Sandbox Environment

  • Private stream: wss://stream-pro.sim.hashkeydev.com/api/v1/ws/{listenKey}

Production Environment

  • Private stream: wss://stream-pro.hashkey.com/api/v1/ws/{listenKey}

bestQuote

  • Push the best quote portfolio to the channel (if at least 3 valid quotations are met within 3s, or all valid quotes after 3s)

  • Only list the latest quote from each LP

  • Ranking principle: rfqMode > Price > quote time

{
  "topic": "bestQuote",
  "data": [
        {
            "id": 9,
            "inquiryOrderId": "MP738048140639408128",
            "lpName": "WX",
            "quoteOrderId": "MPQ738048203885318144",
            "direction": 1,
            "status": 0,
            "buyAssetId": "BTC",
            "buyAmount": "0.0942",
            "sellAssetId": "USDT",
            "sellAmount": "10000",
            "price": "106050",
            "submitTime": 1753772404507,
            "dateExpiry": 1753772464507,
            "expirySeconds": 60,
            "remainingTime": 1122,
            "inquirySettleType": 2,
            "quoteSettleType": 1,
            "rank": 1,
            "isBestPrice": true,
            "isRecommendPrice": true
        },
        {
            "id": 10,
            "inquiryOrderId": "MP738048140639408128",
            "lpName": "GSR",
            "quoteOrderId": "MPQ738048203885318145",
            "direction": 1,
            "status": 0,
            "buyAssetId": "BTC",
            "buyAmount": "0.0942",
            "sellAssetId": "USDT",
            "sellAmount": "10000",
            "price": "106059",
            "submitTime": 1753772404507,
            "dateExpiry": 1753772464507,
            "expirySeconds": 60,
            "remainingTime": 1122,
            "inquirySettleType": 2,
            "quoteSettleType": 1,
            "rank": 2,
            "isBestPrice": false,
            "isRecommendPrice": false
        },
  ]
}

rfqUpdates

{
  "event": "update",
  "topic": "rfqUpdates",
  "data": {
      "rfqId": "RFQ_123",
      "rfqClOrderId": "RFQClOrder_123",
      "buyCcy": "BTC",
      "sellCcy": "USDT",
      "buyAmount": ",
      "sellAmount": "2",
      "rfqMode": "real-time",
      "quoteId": "quote_123",
      "price": 120001,
      "quoteMode": "real-time",
      "status": "accepted",
      "statusInt": "2",
      "isLPReject": false,     
      "expiryTime": 1717410000 
  }
}