Onyx WebSocket API 0.0.1 documentation

Onyx WebSocket API 0.0.1

Onyx WebSocket API. Messages sent and received via WebSocket described in this documentation are encoded in JSON format. There is also a protobuf alternative (not documented here).

Servers

wss://app.onyxhub.co/stream/v2wssproduction
wss://app.uat.onyxhub.co/stream/v2wssuat

Operations

send websocket
Operation IDauthenticate
Available only on servers:
- production
- uat
Accepts the following message:
Message IDauth_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"auth"
token
required
string
Additional properties are allowed.
Examples
{ "id": "string", "client_timestamp": "string", "received_timestamp": "string", "method": "auth", "token": "string" }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: websocket
Address: websocket
Available only on servers:
production
uat
Messages:
#0
Message IDauth_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"auth"
message
required
string
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "auth", "message": "string" }

This example has been generated automatically.
#1
Message IDerror_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"otc_error"
message
required
string
code
required
string
Allowed values:
"unspecified"
"invalid_request"
"not_implemented"
"unauthenticated"
"too_many_requests"
"not_subscribed"
"forbidden"
"internal_server_error"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "otc_error", "message": "string", "code": "unspecified" }

This example has been generated automatically.
send websocket
Operation IDsubscribe
Available only on servers:
- production
- uat
Accepts the following message:
Message IDsubscription_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"subscribe"
required
object oneOf
object [Unspecified]
object
Additional properties are allowed.
Additional properties are allowed.
object [Orders]
object
Additional properties are allowed.
Additional properties are allowed.
object [InternalOrders]
object
Additional properties are allowed.
Additional properties are allowed.
object [ServerInfo]
object
Additional properties are allowed.
Additional properties are allowed.
object [Rfq]
object [RfqChannel]
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
size
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
Additional properties are allowed.
object [Tickers]
object [TickersChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [OrderBookTop]
object [OrderBookTopChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [Dashboards]
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "string", "client_timestamp": "string", "received_timestamp": "string", "method": "subscribe", "channel": { "unspecified": {} } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: websocket
Address: websocket
Available only on servers:
production
uat
Messages:
#0
Message IDsubscription_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"subscribe"
channel
required
string
Allowed values:
"unspecified"
"orders"
"internal_orders"
"dashboards"
"tickers"
"product_risk"
"server_info"
"snapshots"
"rfq"
"order_book_top"
message
required
string
status
required
string
Allowed values:
"unspecified"
"subscribed"
"unsubscribed"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "subscribe", "channel": "unspecified", "message": "string", "status": "unspecified" }

This example has been generated automatically.
#1
Message IDerror_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"otc_error"
message
required
string
code
required
string
Allowed values:
"unspecified"
"invalid_request"
"not_implemented"
"unauthenticated"
"too_many_requests"
"not_subscribed"
"forbidden"
"internal_server_error"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "otc_error", "message": "string", "code": "unspecified" }

This example has been generated automatically.
send websocket
Operation IDunsubscribe
Available only on servers:
- production
- uat
Accepts the following message:
Message IDunsubscription_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"unsubscribe"
required
object oneOf
object [Unspecified]
object
Additional properties are allowed.
Additional properties are allowed.
object [Orders]
object
Additional properties are allowed.
Additional properties are allowed.
object [InternalOrders]
object
Additional properties are allowed.
Additional properties are allowed.
object [ServerInfo]
object
Additional properties are allowed.
Additional properties are allowed.
object [Rfq]
object [RfqChannel]
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
size
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
Additional properties are allowed.
object [Tickers]
object [TickersChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [OrderBookTop]
object [OrderBookTopChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [Dashboards]
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "string", "client_timestamp": "string", "received_timestamp": "string", "method": "unsubscribe", "channel": { "unspecified": {} } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: websocket
Address: websocket
Available only on servers:
production
uat
Messages:
#0
Message IDunsubscription_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"unsubscribe"
channel
required
string
Allowed values:
"unspecified"
"orders"
"internal_orders"
"dashboards"
"tickers"
"product_risk"
"server_info"
"snapshots"
"rfq"
"order_book_top"
message
required
string
status
required
string
Allowed values:
"unspecified"
"subscribed"
"unsubscribed"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "unsubscribe", "channel": "unspecified", "message": "string", "status": "unspecified" }

This example has been generated automatically.
#1
Message IDerror_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"otc_error"
message
required
string
code
required
string
Allowed values:
"unspecified"
"invalid_request"
"not_implemented"
"unauthenticated"
"too_many_requests"
"not_subscribed"
"forbidden"
"internal_server_error"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "otc_error", "message": "string", "code": "unspecified" }

This example has been generated automatically.
send websocket
Operation IDplace_order
Available only on servers:
- production
- uat
Accepts the following message:
Message IDnew_order_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"order"
client_order_id
string
account_id
required
string
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
amount
required
string
price
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
order_type
required
string
Allowed values:
"unspecified"
"fill_or_kill"
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
Examples
{ "id": "string", "client_timestamp": "string", "received_timestamp": "string", "method": "order", "client_order_id": "string", "account_id": "string", "symbol": {}, "amount": "string", "price": "string", "side": "unspecified", "order_type": "unspecified", "exchange": "unspecified" }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: websocket
Address: websocket
Available only on servers:
production
uat
Messages:
#0
Message IDnew_order_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"order"
order_id
required
string
client_order_id
required
string
account_id
required
string
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
product_symbol
required
string
amount
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
order_type
required
string
Allowed values:
"unspecified"
"fill_or_kill"
order_state
required
string
Allowed values:
"unspecified"
"pending_created"
"created"
"new"
"filled"
"errored"
required
object [Trader]
id
required
string
account_name
required
string
full_name
required
string
email
required
string
Additional properties are allowed.
price
required
string
created_timestamp
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
executed_avg_price
string
executed_amount
string
required
array<object [Execution]>
object [Execution]
id
required
string
order_id
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
client_order_id
required
string
account_id
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
created_timestamp
required
string
symbol
required
string
amount
required
string
price
required
string
required
object [Fee]
currency
required
string
signed_amount
required
string
rate
required
string
Additional properties are allowed.
required
object [Trader]
id
required
string
account_name
required
string
full_name
required
string
email
required
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "order", "order_id": "string", "client_order_id": "string", "account_id": "string", "symbol": {}, "product_symbol": "string", "amount": "string", "side": "unspecified", "order_type": "unspecified", "order_state": "unspecified", "user": { "id": "string", "account_name": "string", "full_name": "string", "email": "string" }, "price": "string", "created_timestamp": "string", "exchange": "unspecified", "executed_avg_price": "string", "executed_amount": "string", "executions": [ { "id": "string", "order_id": "string", "side": "unspecified", "client_order_id": "string", "account_id": "string", "exchange": "unspecified", "created_timestamp": "string", "symbol": "string", "amount": "string", "price": "string", "fee": { "currency": "string", "signed_amount": "string", "rate": "string" }, "user": { "id": "string", "account_name": "string", "full_name": "string", "email": "string" } } ] }

This example has been generated automatically.
#1
Message IDerror_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"otc_error"
message
required
string
code
required
string
Allowed values:
"unspecified"
"invalid_request"
"not_implemented"
"unauthenticated"
"too_many_requests"
"not_subscribed"
"forbidden"
"internal_server_error"
Additional properties are allowed.
Examples
{ "id": "string", "timestamp": "string", "method": "otc_error", "message": "string", "code": "unspecified" }

This example has been generated automatically.

Messages

#1
Message IDauth_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"auth"
token
required
string
Additional properties are allowed.
#2
Message IDauth_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"auth"
message
required
string
Additional properties are allowed.
#3
Message IDsubscription_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"subscribe"
required
object oneOf
object [Unspecified]
object
Additional properties are allowed.
Additional properties are allowed.
object [Orders]
object
Additional properties are allowed.
Additional properties are allowed.
object [InternalOrders]
object
Additional properties are allowed.
Additional properties are allowed.
object [ServerInfo]
object
Additional properties are allowed.
Additional properties are allowed.
object [Rfq]
object [RfqChannel]
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
size
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
Additional properties are allowed.
object [Tickers]
object [TickersChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [OrderBookTop]
object [OrderBookTopChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [Dashboards]
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#4
Message IDsubscription_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"subscribe"
channel
required
string
Allowed values:
"unspecified"
"orders"
"internal_orders"
"dashboards"
"tickers"
"product_risk"
"server_info"
"snapshots"
"rfq"
"order_book_top"
message
required
string
status
required
string
Allowed values:
"unspecified"
"subscribed"
"unsubscribed"
Additional properties are allowed.
#5
Message IDunsubscription_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"unsubscribe"
required
object oneOf
object [Unspecified]
object
Additional properties are allowed.
Additional properties are allowed.
object [Orders]
object
Additional properties are allowed.
Additional properties are allowed.
object [InternalOrders]
object
Additional properties are allowed.
Additional properties are allowed.
object [ServerInfo]
object
Additional properties are allowed.
Additional properties are allowed.
object [Rfq]
object [RfqChannel]
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
size
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
Additional properties are allowed.
object [Tickers]
object [TickersChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [OrderBookTop]
object [OrderBookTopChannel]
required
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
object [Dashboards]
object
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#6
Message IDunsubscription_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"unsubscribe"
channel
required
string
Allowed values:
"unspecified"
"orders"
"internal_orders"
"dashboards"
"tickers"
"product_risk"
"server_info"
"snapshots"
"rfq"
"order_book_top"
message
required
string
status
required
string
Allowed values:
"unspecified"
"subscribed"
"unsubscribed"
Additional properties are allowed.
#7
Message IDnew_order_request
Correlation ID$message.payload#/id
object
id
required
string
client_timestamp
required
string
received_timestamp
required
string
method
required
string
Const:"order"
client_order_id
string
account_id
required
string
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
amount
required
string
price
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
order_type
required
string
Allowed values:
"unspecified"
"fill_or_kill"
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
Additional properties are allowed.
#8
Message IDnew_order_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"order"
order_id
required
string
client_order_id
required
string
account_id
required
string
required
object oneOf
object [Unspecified]
Additional properties are allowed.
object [Spread]
front
required
string
back
required
string
Additional properties are allowed.
object [Butterfly]
front
required
string
middle
required
string
back
required
string
Additional properties are allowed.
Or to Flat:
string
Additional properties are allowed.
product_symbol
required
string
amount
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
order_type
required
string
Allowed values:
"unspecified"
"fill_or_kill"
order_state
required
string
Allowed values:
"unspecified"
"pending_created"
"created"
"new"
"filled"
"errored"
required
object [Trader]
id
required
string
account_name
required
string
full_name
required
string
email
required
string
Additional properties are allowed.
price
required
string
created_timestamp
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
executed_avg_price
string
executed_amount
string
required
array<object [Execution]>
object [Execution]
id
required
string
order_id
required
string
side
required
string
Allowed values:
"unspecified"
"buy"
"sell"
client_order_id
required
string
account_id
required
string
exchange
required
string
Allowed values:
"unspecified"
"ice"
"cme"
created_timestamp
required
string
symbol
required
string
amount
required
string
price
required
string
required
object [Fee]
currency
required
string
signed_amount
required
string
rate
required
string
Additional properties are allowed.
required
object [Trader]
id
required
string
account_name
required
string
full_name
required
string
email
required
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#9
Message IDerror_response
Correlation ID$message.payload#/id
object
id
required
string
timestamp
required
string
method
required
string
Const:"otc_error"
message
required
string
code
required
string
Allowed values:
"unspecified"
"invalid_request"
"not_implemented"
"unauthenticated"
"too_many_requests"
"not_subscribed"
"forbidden"
"internal_server_error"
Additional properties are allowed.

Onyx WebSocket API 0.0.1

Servers

Operations

send websocket

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

send websocket

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

send websocket

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

send websocket

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Messages