> ## Documentation Index > Fetch the complete documentation index at: https://docs.voxfi.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Event Channel Playground > Test and interact with the Event channel WebSocket API. ## AsyncAPI ````yaml asyncapi.json event id: event title: Event description: >- Channel for receiving updates about specific events (includes all markets in the event). No authentication required. servers: - id: production protocol: wss host: data-ws.voxfi.com.br bindings: [] variables: - id: heartbeat description: Server heartbeat interval in seconds defaultValue: '10' allowedValues: [] examples: [] address: event parameters: [] bindings: [] operations: - &ref_6 id: event.publish title: Event.publish type: receive messages: - &ref_8 id: publish.message.0 contentType: application/json payload: - name: Subscribe to Event Channel description: Subscribe to receive updates about specific events type: object properties: - name: type type: string description: 'Message type. Default: "subscribe"' required: true - name: channel type: string description: 'Channel type. Default: "event"' required: true - name: events type: array description: Array of event IDs to subscribe to required: true properties: - name: item type: string required: false - name: filter type: string description: >- Type of updates to receive. Empty string or "all" for all updates, "orderbook" for orderbook only, "trades" for trades only examples: &ref_0 - all - orderbook - trades required: false headers: [] jsonPayloadSchema: type: object required: - type - channel - events properties: type: type: string default: subscribe description: 'Message type. Default: "subscribe"' x-parser-schema-id: channel: type: string default: event description: 'Channel type. Default: "event"' x-parser-schema-id: events: type: array items: type: string x-parser-schema-id: description: Array of event IDs to subscribe to minItems: 1 x-parser-schema-id: filter: type: string default: all examples: *ref_0 description: >- Type of updates to receive. Empty string or "all" for all updates, "orderbook" for orderbook only, "trades" for trades only x-parser-schema-id: x-parser-schema-id: SubscribeEventMessage title: Subscribe to Event Channel description: Subscribe to receive updates about specific events example: |- { "type": "subscribe", "channel": "event", "events": [ "event-id-1", "event-id-2" ], "filter": "orderbook" } bindings: [] extensions: - id: x-parser-unique-object-id value: publish.message.0 - &ref_9 id: publish.message.1 contentType: application/json payload: - name: Unsubscribe from Event Channel description: Unsubscribe from specific events type: object properties: - name: type type: string description: 'Message type. Default: "unsubscribe"' required: true - name: channel type: string description: 'Channel type. Default: "event"' required: true - name: events type: array description: Array of event IDs to unsubscribe from required: true properties: - name: item type: string required: false headers: [] jsonPayloadSchema: type: object required: - type - channel - events properties: type: type: string default: unsubscribe description: 'Message type. Default: "unsubscribe"' x-parser-schema-id: channel: type: string default: event description: 'Channel type. Default: "event"' x-parser-schema-id: events: type: array items: type: string x-parser-schema-id: default: [] description: Array of event IDs to unsubscribe from minItems: 1 x-parser-schema-id: x-parser-schema-id: UnsubscribeEventMessage title: Unsubscribe from Event Channel description: Unsubscribe from specific events example: |- { "type": "unsubscribe", "channel": "event", "events": [ "event-id-1" ] } bindings: [] extensions: - id: x-parser-unique-object-id value: publish.message.1 bindings: [] extensions: &ref_5 - id: x-parser-unique-object-id value: event - &ref_7 id: event.subscribe title: Event.subscribe type: send messages: - &ref_10 id: subscribe.message.0 contentType: application/json payload: - name: Subscribe Confirmation description: Confirmation message sent after successful subscription type: object properties: - name: type type: string description: 'Message type. Default: "subscribed"' required: true - name: channel type: string description: >- Channel that was subscribed to. Can be "user", "market", or "event" required: true - name: status type: string description: 'Subscription status. Default: "ok"' required: true - name: markets type: array description: >- Array of market IDs that were subscribed to (only for market channel) required: false properties: - name: item type: string required: false - name: events type: array description: >- Array of event IDs that were subscribed to (only for event channel) required: false properties: - name: item type: string required: false headers: [] jsonPayloadSchema: type: object required: - type - channel - status properties: type: type: string description: 'Message type. Default: "subscribed"' x-parser-schema-id: channel: type: string description: >- Channel that was subscribed to. Can be "user", "market", or "event" x-parser-schema-id: status: type: string description: 'Subscription status. Default: "ok"' x-parser-schema-id: markets: type: array items: type: string x-parser-schema-id: nullable: true description: >- Array of market IDs that were subscribed to (only for market channel) x-parser-schema-id: events: type: array items: type: string x-parser-schema-id: nullable: true description: >- Array of event IDs that were subscribed to (only for event channel) x-parser-schema-id: x-parser-schema-id: SubscribedResponseMessage title: Subscribe Confirmation description: Confirmation message sent after successful subscription example: |- { "type": "subscribed", "channel": "user", "status": "ok", "markets": null, "events": null } bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.0 - &ref_11 id: subscribe.message.1 contentType: application/json payload: - name: Unsubscribe Confirmation description: Confirmation message sent after successful unsubscription type: object properties: - name: type type: string description: 'Message type. Default: "unsubscribed"' required: true - name: channel type: string description: >- Channel that was unsubscribed from. Can be "user", "market", or "event" required: true - name: status type: string description: 'Unsubscription status. Default: "ok"' required: true - name: markets type: array description: >- Array of market IDs that were unsubscribed from (only for market channel) required: false properties: - name: item type: string required: false - name: events type: array description: >- Array of event IDs that were unsubscribed from (only for event channel) required: false properties: - name: item type: string required: false headers: [] jsonPayloadSchema: type: object required: - type - channel - status properties: type: type: string description: 'Message type. Default: "unsubscribed"' x-parser-schema-id: channel: type: string description: >- Channel that was unsubscribed from. Can be "user", "market", or "event" x-parser-schema-id: status: type: string description: 'Unsubscription status. Default: "ok"' x-parser-schema-id: markets: type: array items: type: string x-parser-schema-id: nullable: true description: >- Array of market IDs that were unsubscribed from (only for market channel) x-parser-schema-id: events: type: array items: type: string x-parser-schema-id: nullable: true description: >- Array of event IDs that were unsubscribed from (only for event channel) x-parser-schema-id: x-parser-schema-id: UnsubscribedResponseMessage title: Unsubscribe Confirmation description: Confirmation message sent after successful unsubscription example: |- { "type": "unsubscribed", "channel": "user", "status": "ok", "markets": null, "events": null } bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.1 - &ref_12 id: subscribe.message.2 contentType: application/json payload: - name: Event Orderbook Update description: Update about orderbook changes for any market in an event type: object properties: - name: msg_type type: string description: 'Message type. Default: "update-orderbook"' required: true - name: event_id type: string description: Event ID required: true - name: market_id type: string description: Market ID required: true - name: orderbook type: object required: true properties: - name: yes_orderbook type: object required: true properties: - name: outcome type: string description: Outcome type enumValues: - 'YES' - 'NO' required: true - name: bids type: array description: Buy orders sorted by price descending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: asks type: array description: Sell orders sorted by price ascending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: spread type: integer description: Spread between best ask and best bid required: false - name: last_transaction type: integer description: Last transaction price required: false - name: no_orderbook type: object required: true properties: - name: outcome type: string description: Outcome type enumValues: - 'YES' - 'NO' required: true - name: bids type: array description: Buy orders sorted by price descending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: asks type: array description: Sell orders sorted by price ascending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: spread type: integer description: Spread between best ask and best bid required: false - name: last_transaction type: integer description: Last transaction price required: false - name: market_price_yes type: integer description: Current market price for YES option in ticks (0-100) required: true - name: market_price_no type: integer description: Current market price for NO option in ticks (0-100) required: true - name: chance type: integer description: Implied probability percentage (0-100) required: true - name: volume type: integer description: Total contracts created (historical trades) required: true - name: liquidity type: integer description: Total contracts available in the orderbook required: true - name: spread_yes type: integer description: Spread for YES in ticks required: false - name: spread_no type: integer description: Spread for NO in ticks required: false headers: [] jsonPayloadSchema: type: object required: - msg_type - event_id - market_id - orderbook properties: msg_type: type: string description: 'Message type. Default: "update-orderbook"' x-parser-schema-id: event_id: type: string description: Event ID x-parser-schema-id: market_id: type: string description: Market ID x-parser-schema-id: orderbook: &ref_3 type: object required: - yes_orderbook - no_orderbook - market_price_yes - market_price_no - chance - volume - liquidity properties: yes_orderbook: &ref_2 type: object required: - outcome - bids - asks properties: outcome: type: string enum: - 'YES' - 'NO' description: Outcome type x-parser-schema-id: bids: type: array items: &ref_1 type: object required: - price_ticks - quantity - order_count properties: price_ticks: type: integer description: Price in ticks (0-100) x-parser-schema-id: quantity: type: integer description: Total quantity available at this price level x-parser-schema-id: order_count: type: integer description: Number of orders at this price level x-parser-schema-id: x-parser-schema-id: OrderbookLevel description: Buy orders sorted by price descending x-parser-schema-id: asks: type: array items: *ref_1 description: Sell orders sorted by price ascending x-parser-schema-id: spread: type: integer nullable: true description: Spread between best ask and best bid x-parser-schema-id: last_transaction: type: integer nullable: true description: Last transaction price x-parser-schema-id: x-parser-schema-id: OrderbookSide no_orderbook: *ref_2 market_price_yes: type: integer description: Current market price for YES option in ticks (0-100) x-parser-schema-id: market_price_no: type: integer description: Current market price for NO option in ticks (0-100) x-parser-schema-id: chance: type: integer description: Implied probability percentage (0-100) x-parser-schema-id: volume: type: integer description: Total contracts created (historical trades) x-parser-schema-id: liquidity: type: integer description: Total contracts available in the orderbook x-parser-schema-id: spread_yes: type: integer nullable: true description: Spread for YES in ticks x-parser-schema-id: spread_no: type: integer nullable: true description: Spread for NO in ticks x-parser-schema-id: x-parser-schema-id: Orderbook x-parser-schema-id: OrderbookUpdateMessage title: Event Orderbook Update description: Update about orderbook changes for any market in an event example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.2 - &ref_13 id: subscribe.message.3 contentType: application/json payload: - name: Event Trade Update description: Update about a new trade executed in any market of an event type: object properties: - name: msg_type type: string description: 'Message type. Default: "new-trades"' required: true - name: event_id type: string description: Event ID required: true - name: market_id type: string description: Market ID required: true - name: last_trades type: array description: Array of last trades required: true properties: - name: canceled type: boolean description: Whether the trade was canceled required: true - name: order_id type: integer description: ID of the order required: true - name: user_id type: string description: ID of the user (the user who initiated the trade) required: true - name: total_amount type: integer description: Total amount of the trade in cents required: true - name: qty_contracts type: integer description: Number of contracts traded required: true - name: avg_price type: integer description: Average price of the trade in ticks required: true - name: side type: string description: Trade side enumValues: - BUY - SELL required: true - name: contract_type type: string description: Contract type enumValues: - 'YES' - 'NO' required: true - name: makers type: array description: Array of maker trades that filled the order required: true properties: - name: user_id type: string description: ID of the maker (the user whose order was filled) required: true - name: order_id type: integer description: ID of the order required: true - name: qty_contracts type: integer description: Number of contracts filled from this maker required: true - name: price type: integer description: Price at which this portion was filled required: true - name: total_amount type: integer description: Total amount for this portion in cents required: true - name: side type: string description: Maker order side enumValues: - BUY - SELL required: true - name: contract_type type: string description: Contract type enumValues: - 'YES' - 'NO' required: true headers: [] jsonPayloadSchema: type: object required: - msg_type - event_id - market_id - last_trades properties: msg_type: type: string description: 'Message type. Default: "new-trades"' x-parser-schema-id: event_id: type: string description: Event ID x-parser-schema-id: market_id: type: string description: Market ID x-parser-schema-id: last_trades: type: array items: &ref_4 type: object required: - canceled - order_id - user_id - total_amount - qty_contracts - avg_price - side - contract_type - makers properties: canceled: type: boolean description: Whether the trade was canceled x-parser-schema-id: order_id: type: integer description: ID of the order x-parser-schema-id: user_id: type: string description: ID of the user (the user who initiated the trade) x-parser-schema-id: total_amount: type: integer description: Total amount of the trade in cents x-parser-schema-id: qty_contracts: type: integer description: Number of contracts traded x-parser-schema-id: avg_price: type: integer description: Average price of the trade in ticks x-parser-schema-id: side: type: string enum: - BUY - SELL description: Trade side x-parser-schema-id: contract_type: type: string enum: - 'YES' - 'NO' description: Contract type x-parser-schema-id: makers: type: array items: type: object required: - user_id - order_id - qty_contracts - price - total_amount - side - contract_type properties: user_id: type: string description: ID of the maker (the user whose order was filled) x-parser-schema-id: order_id: type: integer description: ID of the order x-parser-schema-id: qty_contracts: type: integer description: Number of contracts filled from this maker x-parser-schema-id: price: type: integer description: Price at which this portion was filled x-parser-schema-id: total_amount: type: integer description: Total amount for this portion in cents x-parser-schema-id: side: type: string enum: - BUY - SELL description: Maker order side x-parser-schema-id: contract_type: type: string enum: - 'YES' - 'NO' description: Contract type x-parser-schema-id: x-parser-schema-id: MakerTrade description: Array of maker trades that filled the order x-parser-schema-id: x-parser-schema-id: Trade description: Array of last trades x-parser-schema-id: x-parser-schema-id: TradeUpdateMessage title: Event Trade Update description: Update about a new trade executed in any market of an event example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.3 - &ref_14 id: subscribe.message.4 contentType: application/json payload: - name: Event Full Update description: >- Complete update including both orderbook and trade information for any market in an event type: object properties: - name: msg_type type: string description: 'Message type. Default: "update"' required: true - name: event_id type: string description: Event ID required: true - name: market_id type: string description: Market ID required: true - name: orderbook type: object required: true properties: - name: yes_orderbook type: object required: true properties: - name: outcome type: string description: Outcome type enumValues: - 'YES' - 'NO' required: true - name: bids type: array description: Buy orders sorted by price descending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: asks type: array description: Sell orders sorted by price ascending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: spread type: integer description: Spread between best ask and best bid required: false - name: last_transaction type: integer description: Last transaction price required: false - name: no_orderbook type: object required: true properties: - name: outcome type: string description: Outcome type enumValues: - 'YES' - 'NO' required: true - name: bids type: array description: Buy orders sorted by price descending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: asks type: array description: Sell orders sorted by price ascending required: true properties: - name: price_ticks type: integer description: Price in ticks (0-100) required: true - name: quantity type: integer description: Total quantity available at this price level required: true - name: order_count type: integer description: Number of orders at this price level required: true - name: spread type: integer description: Spread between best ask and best bid required: false - name: last_transaction type: integer description: Last transaction price required: false - name: market_price_yes type: integer description: Current market price for YES option in ticks (0-100) required: true - name: market_price_no type: integer description: Current market price for NO option in ticks (0-100) required: true - name: chance type: integer description: Implied probability percentage (0-100) required: true - name: volume type: integer description: Total contracts created (historical trades) required: true - name: liquidity type: integer description: Total contracts available in the orderbook required: true - name: spread_yes type: integer description: Spread for YES in ticks required: false - name: spread_no type: integer description: Spread for NO in ticks required: false - name: last_trades type: array description: Array of last trades required: true properties: - name: canceled type: boolean description: Whether the trade was canceled required: true - name: order_id type: integer description: ID of the order required: true - name: user_id type: string description: ID of the user (the user who initiated the trade) required: true - name: total_amount type: integer description: Total amount of the trade in cents required: true - name: qty_contracts type: integer description: Number of contracts traded required: true - name: avg_price type: integer description: Average price of the trade in ticks required: true - name: side type: string description: Trade side enumValues: - BUY - SELL required: true - name: contract_type type: string description: Contract type enumValues: - 'YES' - 'NO' required: true - name: makers type: array description: Array of maker trades that filled the order required: true properties: - name: user_id type: string description: ID of the maker (the user whose order was filled) required: true - name: order_id type: integer description: ID of the order required: true - name: qty_contracts type: integer description: Number of contracts filled from this maker required: true - name: price type: integer description: Price at which this portion was filled required: true - name: total_amount type: integer description: Total amount for this portion in cents required: true - name: side type: string description: Maker order side enumValues: - BUY - SELL required: true - name: contract_type type: string description: Contract type enumValues: - 'YES' - 'NO' required: true headers: [] jsonPayloadSchema: type: object required: - msg_type - event_id - market_id - orderbook - last_trades properties: msg_type: type: string description: 'Message type. Default: "update"' x-parser-schema-id: event_id: type: string description: Event ID x-parser-schema-id: market_id: type: string description: Market ID x-parser-schema-id: orderbook: *ref_3 last_trades: type: array items: *ref_4 description: Array of last trades x-parser-schema-id: x-parser-schema-id: FullUpdateMessage title: Event Full Update description: >- Complete update including both orderbook and trade information for any market in an event example: No examples found bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.4 bindings: [] extensions: *ref_5 sendOperations: - *ref_6 receiveOperations: - *ref_7 sendMessages: - *ref_8 - *ref_9 receiveMessages: - *ref_10 - *ref_11 - *ref_12 - *ref_13 - *ref_14 extensions: - id: x-parser-unique-object-id value: event securitySchemes: [] ````