Overview Table#
| Object Type | Description | Main Usage |
|---|
| Participant | Represents a trading participant/entity in the system | Used in orders, trades, and offers to identify trading parties |
| Account | Trading account belonging to a participant and user | Used to track trading activities and permissions |
| Market | Defines where trading activities take place | |
| Instrument | Financial instrument that can be traded | Defines what is being traded |
| User | System user associated with participants | Manages who can perform trading actions |
| Offer | Trading intention or quote | Initiates potential trades |
| Order | Confirmed trading instruction | Represents actionable trades |
| Trade | Executed transaction between parties | Records completed trades |
| OHLC | Open High Low Close market data | Provides price history and real-time market data |
Detailed Field Tables#
Participant Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| lei | string | Legal Entity Identifier | Yes |
| type | string | Always 'legal_entity' | Yes |
| category_name | string | Either 'professional' or 'wholesale' | Yes |
| name | string | Company name | Yes |
| address | string | Street address | Yes |
| postal_code | string | Postal/ZIP code | Yes |
| city | string | City | Yes |
| state | string | State/Province | Yes |
| country | string | Country code | Yes |
| legal_form | string | Legal structure type | Yes |
| registration_number | string | Company registration number | No |
| tax_number | string | Tax identification number | No |
| status | string | 'active' or 'pending' | Yes |
| kyc_status | string | Always 'successful' | Yes |
| csd | string | Central Securities Depository | No |
| csd_bic_11 | string | BIC/SWIFT code (11 chars) | No |
| custody_account_number | string | Custody account number | No |
| custody_account_beneficiary_bic_8 | string | Beneficiary BIC (8 chars) | No |
| createdAt | string | Creation timestamp | Yes |
| updatedAt | string | Last update timestamp | Yes |
Account Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| number | string | Account number | Yes |
| status | string | Always 'active' | Yes |
| type | string | Always 'market_maker' | Yes |
| participant | Participant | Full participant object | No |
| participant_id | string | Reference to participant | Yes |
| createdAt | string | Creation timestamp | Yes |
| updatedAt | string | Last update timestamp | Yes |
Market Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| name | string | Market name | Yes |
| type | string | '360X DLT MTF', '360X OTC', or '360X MTF' | Yes |
| facility_type | string | 'continues-matching' or 'BTF' | Yes |
| timezone | string | Market timezone | Yes |
| is_enabled | boolean | Market status | Yes |
| is_partial_fill_allowed | boolean | Whether partial fills are allowed | Yes |
Instrument Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| name | string | Instrument name | Yes |
| type | string | Instrument type | Yes |
| icon_url | string | Icon URL | No |
| precision | number | Decimal precision | Yes |
| contract_config | object | Contract configuration | No |
| fee_limit_config | object | Fee limits configuration | No |
| subunits_config | number | Subunit configuration | Yes |
| minimal_collection_amount | number | Minimum collection amount | No |
| withdraw_fee | number | Withdrawal fee | Yes |
| max_withdrawal_amount | number | Maximum withdrawal amount | No |
| min_withdraw_fee | number | Minimum withdrawal fee | Yes |
| max_withdraw_fee | number | Maximum withdrawal fee | Yes |
| balance | number | Current balance | No |
| buyer_primary_fee | number | Primary buyer fee | No |
| buyer_secondary_fee | number | Secondary buyer fee | No |
| seller_secondary_fee | number | Secondary seller fee | No |
| seller_primary_fee | number | Primary seller fee | No |
| transaction_fees_approved | boolean | Fee approval status | Yes |
| state | string | Always 'PRIMARY' | Yes |
| visibility | boolean | Public visibility | Yes |
| product_page_url | string | Product details URL | Yes |
| repayment_enabled | boolean | Repayment status | No |
| terms_url | string | Terms document URL | No |
| issuer_participant_id | string | Issuer reference | No |
| industry | string | Industry sector | Yes |
| isin | string | ISIN code | Yes |
| mkt_iss | string | Market issuer | Yes |
| country_region | string | Geographic region | Yes |
| rank | string | Instrument rank | Yes |
| secured | string | Security status | Yes |
| coupon | string | Coupon rate | Yes |
| coupon_frequency | string | Coupon payment frequency | No |
| day_count | string | Day count convention | Yes |
| maturity | string | Maturity date | No |
| repayment | string | Repayment terms | Yes |
| currency | string | Trading currency | Yes |
| series | string | Instrument series | Yes |
| coupon_type | string | Type of coupon | Yes |
| issue_price | string | Initial issue price | Yes |
| bid_limit | string | Bid limit | Yes |
| ask_limit | string | Ask limit | Yes |
| ask_quantity | string | Ask quantity limit | Yes |
| reoffer | string | Reoffer terms | Yes |
| iss_sprd | string | Issue spread | Yes |
| benchmark_ref_px | string | Benchmark reference price | Yes |
| benchmark_ref_yield | string | Benchmark reference yield | Yes |
| irs_yield | string | IRS yield | Yes |
| iss_sprd_vs_irs | string | Spread vs IRS | Yes |
| pricing_date | string | Pricing date | No |
| interest_accrual_date | string | Interest accrual start | No |
| first_settle_date | string | First settlement date | No |
| first_coupon_date | string | First coupon date | No |
| amt_issue | string | Issue amount | Yes |
| amt_outstanding | string | Outstanding amount | Yes |
| min_piece | string | Minimum piece size | Yes |
| min_increment | string | Minimum increment | Yes |
| par_amount | string | Par amount | Yes |
| book_runner | string | Book runner name | Yes |
| exchange | string | Exchange name | Yes |
| note | string | Additional notes | No |
| issuer | string | Issuer name | Yes |
| lei | string | LEI code | No |
| unit_quotation | string | Quotation unit | Yes |
| instrument_limits | object | Contains ask/bid arrays | Yes |
Instrument Price Change Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| name | string | Instrument name | Yes |
| best_ask_price | string | Best ask price for instrument on market | Yes |
| best_bid_price | string | Best bid price for instrument on market | Yes |
User Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| email | string | User email | Yes |
| role | string | 'USER' or 'PARTICIPANT_ADMIN' | Yes |
| is_email_verified | boolean | Email verification status | Yes |
| identification_status | string | Always 'successful' | Yes |
| is_login_two_fa_enabled | boolean | 2FA status | Yes |
| terms_conditions_signed | boolean | T&C acceptance | Yes |
| status | string | 'active' or 'pending' | Yes |
| locale | string | User locale | Yes |
| participant_id | string | Associated participant | No |
| last_active | string | Last activity timestamp | Yes |
Offer Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| direction | string | 'ask', 'bid', or 'two_way' | Yes |
| price | number | Offer price | Yes |
| quantity | number | Offer quantity | Yes |
| price_per_unit_clean | number | Clean price per unit | Yes |
| status | string | 'created', 'cancelled', or 'closed' | Yes |
| type | string | 'offer', 'request_for_quote', or 'quote' | Yes |
| market_order | boolean | Market order flag | Yes |
| filled_quantity | number | Filled quantity | Yes |
| settlement_date | string | Settlement date | No |
| validity | string | 'gtc', 'gfd', 'gtd', 'custom' | Yes |
| valid_until | string | Validity end date | No |
| is_executable | boolean | Executability flag | Yes |
| participant_id | string | Reference to participant | Yes |
| participant | Participant | Full participant object | Yes |
| market_id | string | Reference to market | Yes |
| market | Market | Full market object | Yes |
| instrument_id | string | Reference to instrument | Yes |
| instrument | Instrument | Full instrument object | Yes |
| user_id | string | Reference to user | No |
| user | User | Full user object | No |
| account_id | string | Reference to account | Yes |
| account | Account | Full account object | Yes |
Order Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| direction | string | 'ask', 'bid', or 'two_way' | Yes |
| price | number | Order price | Yes |
| quantity | number | Order quantity | Yes |
| price_per_unit | number | Price per unit | Yes |
| filled_quantity | number | Filled quantity | Yes |
| status | string | Always 'internally_approved' | Yes |
| type | string | Always 'limit_order' | Yes |
| expires_at | string | Expiration timestamp | Yes |
| offer_id | string | Reference to originating offer | Yes |
| offer | Offer | Complete offer object that initiated this order | Yes |
Trade Fields#
| Field Name | Type | Description | Required |
|---|
| id | string | Unique identifier | Yes |
| transaction_identification_code | string | Transaction ID | Yes |
| execution_type | string | Type of execution | Yes |
| quantity | number | Trade quantity | Yes |
| price | number | Trade price | Yes |
| price_per_unit | number | Price per unit | Yes |
| fee | number | Trade fee | Yes |
| status | string | Trade status | Yes |
| settlement_date | string | Settlement date | No |
| bid_order | Order | Complete buy order object | Yes |
| ask_order | Order | Complete sell order object | Yes |
| market_id | string | Reference to market | Yes |
OHLC Fields#
| Field Name | Type | Description | Required |
|---|
| date | string | Date for the OHLC data (YYYY-MM-DD) | Yes |
| open | number | Opening price from first trade of the day | No |
| high | number | Highest trade price of the day | No |
| low | number | Lowest trade price of the day | No |
| close | number | Closing price from last trade of the day | No |
| volume | number | Total trading volume for the day | No |
| open_bid | number | First available bid offer price at market open | No |
| open_ask | number | First available ask offer price at market open | No |
| close_bid | number | Last executed bid trade price | No |
| close_ask | number | Last executed ask trade price | No |
| midpoint | number | Calculated midpoint between bid and ask | No |
| net_change | number | Net price change from previous close | No |
| percent_change | number | Percentage change from previous close | No |
| net_change_day | number | Net change for the trading day | No |
| percent_change_day | number | Percentage change for the trading day | No |
| net_change_period | number | Net change for the period | No |
| percent_change_period | number | Percentage change for the period | No |
| sentiment | string | 'positive', 'negative', 'neutral', or 'no-data' | Yes |
| price_range | number | Difference between high and low | No |
| average_price | number | Volume-weighted average price | No |
News Fields#
| Field Name | Type | Description | Required |
|---|
| title | string | News Title | Yes |
| category | string | News category | Yes |
| content | string | News Text | Yes |
| instrument_id | string | Instrument Id in News | No |
| instrument_name | String | Instrument Name in News | No |
| isin | String | Instrument ISIN in News | No |
| bucket_name | string | Name of Bucket | No |
| market | string | Reference to market | No |
WebSocket Streaming#
OHLC Streaming#
Real-time OHLC data is available via WebSocket connection:ohlc.data - Initial OHLC data when subscribing
ohlc.update - Real-time OHLC updates when offers/trades occur
Common Field Patterns#
All timestamps use ISO 8601 format
All IDs are strings (UUIDs)
Money values use number type with defined precision
Status fields use predefined string enums
Foreign keys end with '_id'
Many fields have corresponding full objects (e.g., market_id and market)
OHLC data distinguishes between trade-based prices (open/high/low/close) and offer-based prices (open_bid/open_ask/close_bid/close_ask)
Modified at 2025-07-28 13:23:41