Method: CHANNEL
Version: 1.0.0

## Servers

### uat
TrueX UAT websocket sandbox server.
Host: uat.truex.co
Protocol: wss

### production
TrueX production websocket server.
Host: prod.truex.co
Protocol: wss

## Messages

### subscription

#### Payload Schema

- **type** (string)
  Action the request is intending to take.
  Enum: SUBSCRIBE, SUBSCRIBE_NO_AUTH, UNSUBSCRIBE

- **item_names** (array)
  List of items the request is intending to act upon.

- **channels** (array)
  List of channels the request is intending to interact with.

- **timestamp** (string)
  Required field on all requests; a UTC Unix epoch in seconds. Must be with 15 seconds of the servers current time.


- **organization_id** (string)
  Exchange designation ID will be UUIDv4. Must be supplied in human readable form. RFC 9562.

- **key** (string)
  Exchange supplied API key will be in UUIDv4. Must be supplied in huyman readable form. RFC 9562.

- **signature** (string)
  The computed HMAC signature.

### welcome

#### Payload Schema

- **connections** (string)
  Current number of active connections from the source IP.

- **channel** (string)
  Channel this message orignated from.
  Enum: WEBSOCKET

- **update** (string)
  Type of update for the current message.
  Enum: WELCOME

- **message** (string)
  Message supplied when initiating a connection with the server.

- **version** (string)
  Current version of the websocket API.

- **datetime** (string)
  Current datetime of when the server sent the message,

### confirmation

#### Payload Schema

- **timestamp** (string)
  Server timestamp when the confirmation was generated.

- **channel** (string)
  Channel this message orignated from.
  Enum: WEBSOCKET

- **update** (string)
  Type of update for the current message.
  Enum: SNAPSHOT, UPDATE

- **status** (string)
  Current status of the websocket connection.
  Enum: INVALID, ERROR, UNAUTHORIZED, UNAUTHENTICATED, AUTHENTICATED

- **subscriptions** (array)

- **channel** (string)

- **item_names** (array)

### instrument

#### Payload Schema

- **seqnum** (string)
  Current sequence number of the channel.

- **channel** (string)
  Channel this message orignated from.
  Enum: INSTRUMENT

- **update** (string)
  Type of update for the current message.
  Enum: SNAPSHOT, UPDATE

- **data** (object)

- **id** (string)
  Exchange assigned ID of the instrument.

- **status** (string)
  Current instrument state.
  Enum: DISABLED, OPENING, ACTIVE, HALTED

- **info** (object)

- **symbol** (string)
  Human readable representation of the instrument.

- **reference_price** (string)
  Price used for initial price limit/band calcuations.

- **base_asset_id** (string)
  ID of the base asset.

- **quote_asset_id** (string)
  ID of the quote asset.

- **price_limit_window_secs** (string)
  Number of seconds in the price limit's sliding window.

- **price_limit_percent** (string)
  Specifies the percentage threshold for price movement beyond a reference price (e.g., the midpoint or previous close) at which the exchange will take action. If the price of a trade or order breaches this threshold, the exchange may halt trading, trigger a circuit breaker, or initiate other predefined actions to ensure market stability.

- **price_bands_percent** (string)
  Defines the acceptable price range for order validation within the market. The price bands ensure that orders are priced within a range around the market's midpoint, adjusted for increments and thresholds.

- **stats** (object)

- **last_24hr_notional** (string)
  The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.

- **last_24hr_quantity** (string)
  The quantity traded over the last 24 hour period.

### trade

#### Payload Schema

- **seqnum** (string)
  Current sequence number of the channel.

- **channel** (string)
  Channel this message orignated from.
  Enum: TRADE

- **update** (string)
  Type of update for the current message.
  Enum: SNAPSHOT, UPDATE

- **data** (object)

- **match_id** (string)
  A unique identifier for the trade match event.

- **taking_side** (string)
  Which side initiated the trade.
  Enum: BUY, SELL

- **info** (object)
  Last trade information.

- **price** (string)

- **qty** (string)

- **timestamp** (string)
  The Unix UTC timestamp (in nanoseconds) when the event occured.

- **symbol** (string)
  Human readable representation of the instrument.

### ebbo

#### Payload Schema

- **seqnum** (string)
  Current sequence number of the channel.

- **channel** (string)
  Channel this message orignated from.
  Enum: EBBO

- **update** (string)
  Type of update for the current message.
  Enum: SNAPSHOT, UPDATE

- **data** (object)

- **id** (string)
  Exchange assigned ID of the market data.

- **symbol** (string)
  Human readable representation of the instrument.

- **info** (object)

- **last_trade** (object)
  Last trade information.

- **price** (string)

- **qty** (string)

- **timestamp** (string)
  The Unix UTC timestamp (in nanoseconds) when the event occured.

- **best_bid** (object)
  Current exchange best bid.

- **price** (string)
  Price at this level.

- **qty** (string)
  Aggregate quantity resting at this level.

- **depth** (string)
  Number of orders resting at this level.

- **best_ask** (object)
  Current exchange best ask.

- **last_update** (string)
  A UTC Unix epoch in nanoseconds indicating when the book was last updated.

### depth

#### Payload Schema

- **seqnum** (string)
  Current sequence number of the channel.

- **channel** (string)
  Channel this message orignated from.
  Enum: DEPTH

- **update** (string)
  Type of update for the current message.
  Enum: SNAPSHOT, UPDATE

- **data** (object)

- **symbol** (string)
  Human readable representation of the instrument.

- **bids** (array)

- **price** (string)
  Price at this level.

- **qty** (string)
  Aggregate quantity resting at this level.

- **depth** (string)
  Number of orders resting at this level.

- **asks** (array)