API Reference

Public Stream

Access URL

Sandbox Environment

  • Public stream: wss://stream-pro.sim.hashkeydev.com/quote/ws/v1

Production Environment

  • Public stream: wss://stream-pro.hashkey.com/quote/ws/v1

Request Parameters


ParameterTypeRequiredExample valueDescription
eventSTRINGYSUBSCRIBE , UNSUBSCRIBE sub , cancel
topicSTRINGYrfqs, quotes

Request Demo

{
    "event": "SUBSCRIBE",
    "topic": "rfqs"
}

WS Push Demo

rfqs: Public channel, push all "new" RFQs

  • newly created rfqs or rfqs becomes "new" again (like accepted quote expired before confirmation, the rfq will becomes "new")
{
  "event": "rfqCreated",
  "topic": "rfqs",
  "data": {
      "rfqId": "RFQ_123",
      "buyCcy": "BTC",
      "sellCcy": "USDT",
      "buyAmount": "2",
      "sellAmount": "",
      "rfqMode": "real-time",
      "expire_time": 1717410000 // Unix timestamp
  }
}

quotes: Public channel, push all quotes once created

{
  "event": "quotesCreated",
  "topic": "quotes",
  "data": {
    "quoteId": "QUOTE_789456123",
    "rfqId": "RFQ638459562162049024",
    "buyCcy": "BTC",
    "sellCcy": "USDT",
    "buyAmount": "2",
    "sellAmount": "",
    "price": "68900",
    "expireTime": 1717394200
  }
}