Quote

WebSocket Authentication

WebSocket Event: auth

Authenticate your WebSocket connection using your secret key. This must be the first event sent after establishing a WebSocket connection.

Connection:

Connect to: ws://api.obsidiam.com:3030 (or the configured WebSocket port)
Transport: WebSocket or polling

Event Flow:

Establish WebSocket connection
Send auth event with your secret key
Upon successful authentication, you’ll start receiving quotation events
You’ll also receive periodic heartbeat events to keep the connection alive

Use Cases:

Real-time cryptocurrency price quotes
Live quote updates for your company’s configured spreads
Monitoring price changes for trading decisions

POST

quote

websocket

auth

WebSocket Authentication

curl --request POST \
  --url http://api.obsidiam.com/quote/websocket/auth \
  --header 'Content-Type: application/json' \
  --data '
{
  "secretKey": "<string>",
  "token": "<string>"
}
'

{
  "success": true,
  "message": "Authenticated successfully"
}

Body

application/json

secretKey

string

token

string

Response

Authentication successful. You will now receive quotation events.

success

boolean

Example:

true

message

string

Example:

"Authenticated successfully"

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

⌘I

WebSocket Authentication

curl --request POST \
  --url http://api.obsidiam.com/quote/websocket/auth \
  --header 'Content-Type: application/json' \
  --data '
{
  "secretKey": "<string>",
  "token": "<string>"
}
'

{
  "success": true,
  "message": "Authenticated successfully"
}

Endpoints

Body

Response