Namespaces and Events

Each namespace handles specific types of events related to trading activities:

Namespace	Purpose	Primary Object Type	Related Objects
`offers`	Handles offer lifecycle	Offer	Instrument, Market, Account, Participant
`orders`	Manages order processing	Order	Offer, Instrument, Market, Account
`trades`	Tracks trade execution	Trade	Order (bid/ask), Market
`instruments`	Tracks price change for instruments	Instrument Price Change	Order (bid/ask), Market, Instrument
`ohlc`	Provides real-time market data	OHLC	Instrument, Offer, Trade

Detailed Event Specifications

Offers Namespace (`/offers`)

Offer Events

Event	Description	Key Fields to Monitor	Status Changes
`offer.create`	New offer creation	price, quantity, direction, validity	status = 'created'
`offer.update`	Offer modification	price, quantity, settlement_date	status unchanged
`offer.delete`	Offer cancellation	message, modified_at	status = 'cancelled'

RFQ Events

Event	Description	Key Fields to Monitor	Special Considerations
`rfq.create`	New RFQ creation	quantity, direction, counterparties	type = 'request_for_quote'
`rfq.update`	RFQ modification	quantity, settlement_date	Maintains RFQ type
`rfq.delete`	RFQ cancellation	message, counterparties	status = 'cancelled'

RFQ specifics:

Uses Offer object structure

Always has type = 'request_for_quote'

Can include counterparties array

Price usually 0 for initial request

Quote Events

Event	Description	Key Fields to Monitor	Related Objects
`quote.create`	New quote creation	price, quantity, matched_offer_id	References RFQ
`quote.update`	Quote modification	price, quantity, valid_until	Original RFQ
`quote.delete`	Quote cancellation	message, status	RFQ status

Quote specifics:

Uses Offer object structure

Always has type = 'quote'

References original RFQ in matched_offers array

Includes specific price/quantity terms

Orders Namespace (`/orders`)

Order Events

Event	Description	Required Fields	Optional Fields
`order.create`	Order creation	price, quantity, direction	offer_id, settlement_date

Order event specifics:

Contains full Account object

References original Offer if created from quote

Includes detailed Instrument information

See Order object definition for complete structure

Trades Namespace (`/trades`)

Trade Events

Event	Description	Key Components	Status Information
`trade.create`	Trade execution	bid_order, ask_order, price	execution_type, status

Trade specifics:

Contains complete Order objects for both sides

Includes full Market details

Generates unique transaction_identification_code

See Trade object definition for full structure

Instrument Namespace (`/instruments`)

Instrument Events

Event	Description	Key Components
`instruments.priceChanged`	Instrument price changed	best_bid_price, best_ask_price, instrument_id

Instrument Price change event specifics:

Current best bid price for that instrument

Current best ask price for that instrument

This event is triggered any time there is change in price for instruments i.e. when new offers/trades are created, updated or closed

News Namespace (`/news`)

News Events

Event	Description	Key Components
`news.create`	News Created	title, category, content

News created event is triggered any time new event like below occurs

Instrument created/updated

Instrument added to bucket

OHLC Namespace (`/ohlc`)

OHLC Events

Event	Description	Key Components	Trigger Conditions
`ohlc.data`	Initial OHLC data	instrument_id, ohlc	On subscription to instrument
`ohlc.update`	Real-time OHLC updates	instrument_id, ohlc	When offers/trades occur

OHLC event specifics:

Subscribe to general namespace: socket.emit('subscribe') - receives ohlc.data confirmation

Subscribe to specific instrument: socket.emit('subscribe_instrument', { instrument_id: 'id' }) - receives ohlc.data with current market data

Real-time updates: Automatically receive ohlc.update events when:

New offers are created, updated, or cancelled

Trades are executed

Market conditions change

OHLC data includes:

Trade-based prices: open, high, low, close, volume

Offer-based prices: open_bid, open_ask, close_bid, close_ask

Calculated fields: midpoint, net_change, percent_change, sentiment

Event Flow States

Offer Lifecycle States

Created → Matched → Cancelled/Closed

RFQ to Trade Flow

RFQ Created → Quote Created → Order Created → Trade Executed

Event Payload References

All events carry payloads that match the object definitions provided earlier:

Offer events: See Offer Fields in Object Definitions

Order events: See Order Fields in Object Definitions

Trade events: See Trade Fields in Object Definitions

OHLC events: See OHLC Fields in Object Definitions

Each event type inherits fields from its corresponding object definition, ensuring consistency across the platform. Refer to the Object Definitions section for complete field listings and data types.

Detailed Event Specifications#

Offers Namespace (/offers)#

Offer Events#

RFQ Events#

Quote Events#

Orders Namespace (/orders)#

Order Events#

Trades Namespace (/trades)#

Trade Events#

Instrument Namespace (/instruments)#

Instrument Events#

News Namespace (/news)#

News Events#

OHLC Namespace (/ohlc)#

OHLC Events#

Event Flow States#

Offer Lifecycle States#

RFQ to Trade Flow#

Event Payload References#