Quote

WebSocket Quotation Event

WebSocket Event: quotation

Receive real-time cryptocurrency price quotes. This event is emitted by the server after successful authentication.

Event Details:

Event Name: quotation
Direction: Server → Client
Frequency: Real-time as quotes become available
Spread: The ask price includes your company’s configured spread

Response Structure: The quotation event includes:

Product and quote identifiers
Cryptocurrency symbol and settlement schedule
Ask price (with your company’s spread already applied)
Timestamp and provider information

Use Cases:

Display real-time prices in your application
Trigger trading decisions based on price changes
Monitor market conditions for specific cryptocurrencies

GET

quote

websocket

quotation

WebSocket Quotation Event

curl --request GET \
  --url http://api.obsidiam.com/quote/websocket/quotation

{
  "productId": "<string>",
  "symbol": "USDT",
  "settlement": "D0",
  "id": "<string>",
  "ask": "<string>",
  "time": "2023-11-07T05:31:56Z",
  "providerId": "<string>"
}

Response

200 - application/json

Example quotation event payload

productId

string

required

Product identifier

symbol

enum<string>

required

Cryptocurrency symbol

Available options:

USDT,

USDC

settlement

enum<string>

required

Settlement schedule (D0, D1, D2)

Available options:

D0,

D1,

D2

string

required

Quote identifier

ask

string

required

Ask price with company spread applied (decimal string)

time

string<date-time>

required

Quote timestamp

providerId

string

FX provider identifier

WebSocket Heartbeat Event**WebSocket Event: `heartbeat`** Periodic heartbeat events sent by the server to keep the connection alive and verify connectivity. **Event Details:** - **Event Name:** `heartbeat` - **Direction:** Server → Client - **Frequency:** Every 10 seconds - **Purpose:** Connection keep-alive and health check **Response Structure:** The heartbeat event contains a Unix timestamp indicating when the heartbeat was sent. **Use Cases:** - Monitor connection health - Detect connection drops - Implement reconnection logic if heartbeats stop

⌘I

WebSocket Quotation Event

curl --request GET \
  --url http://api.obsidiam.com/quote/websocket/quotation

{
  "productId": "<string>",
  "symbol": "USDT",
  "settlement": "D0",
  "id": "<string>",
  "ask": "<string>",
  "time": "2023-11-07T05:31:56Z",
  "providerId": "<string>"
}

Endpoints

Response