API Reference
Start typing to search…

2026.01

To empower institutional and professional trading clients, we now provide the client-side API integration suite for the Market Place RFQ trading platform. This allows your systems to automate the initiation, monitoring, and management of large, customized trade requests (RFQs) and interact efficiently with Liquidity Providers (LPs). Integration Process & Technical Highlights

  1. Core Operational Workflow A typical automated RFQ workflow involves the following steps:
  2. Fetch Tradable Pairs: Call the GET /api/v1/market-place/get-pairs endpoint to confirm if the target trading pair is available and matches your client type.
  3. Initiate an RFQ: Create an RFQ via the dedicated client-side endpoint (please refer to exclusive technical documentation for specifics https://hashkeypro-apidoc.readme.io/reference/get-quote-pairs ). Key required fields include the trading pair, side (buy/sell), quantity (sellAmount), and the RFQ mode (rfqMode).
  4. Listen to Market & Quote Streams: Subscribe to the public rfqs WebSocket channel for market intelligence. Simultaneously, your system will receive quote notifications for your RFQs via private channels.
  5. Accept Quote & Track Status: Once a desirable quote is received, accept it via API. You can then track the final status (e.g., SUCCESSFUL, EXPIRED) of that RFQ using the order query endpoints.
  6. Key Data Field Specifications Pay close attention to the following fields when initiating and managing RFQs:
  • rfqId: The unique identifier generated by the system for each RFQ, serving as the index for all subsequent operations.
  • buyCcy / sellCcy & sellAmount: Define the trade direction and quantity.
  • rfqMode: The RFQ mode (e.g., real-time), which may affect the settlement speed of quotes.
  • status: The lifecycle status of the RFQ (e.g., NEW, ACCEPTED, EXPIRED), crucial for determining available actions.
  • expireTime: The validity expiry timestamp for the RFQ or a quote. Your system must make decisions before this time.
  1. Real-time Communication (WebSocket)
  • Public Channel (rfqs): Subscribing to this channel provides real-time broadcasts of all newly created RFQs across the platform, useful for market analysis.
  • Private Channels: You will receive critical real-time events via private channels, such as:
    • Notifications for new quotes from LPs on your RFQs.
    • Confirmation status updates for quotes you have accepted.
    • Final trade execution notices for relevant orders.
  1. Error Handling & Permissions
  • Permissions: All related API calls require authentication using your account's API Key and signature.
  • Error Codes: Please handle common error codes (e.g., -6100 for insufficient permissions, -6101 for parameter errors) and adjust requests based on API responses. This client-side API suite is designed to help you seamlessly integrate large-volume trading workflows into your own systems, enabling automated and efficient RFQ-based trading.