> ## 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. # User Channel Playground > Enable users to interact with your websockets. ## AsyncAPI ````yaml asyncapi.json user id: user title: User description: >- Channel for receiving updates about your own orders and transactions. Requires authentication. 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: user parameters: [] bindings: - protocol: ws version: latest value: query: type: object properties: auth: type: string description: API Key (X-Api-Key) - required for user channel schemaProperties: - name: query type: object required: false properties: - name: auth type: string description: API Key (X-Api-Key) - required for user channel required: false operations: - &ref_4 id: user.publish title: User.publish type: receive messages: - &ref_6 id: publish.message.0 contentType: application/json payload: - name: Subscribe to User Channel description: >- Subscribe to receive updates about your own orders and transactions type: object properties: - name: type type: string description: 'Message type. Default: "subscribe"' required: true - name: channel type: string description: 'Channel type. Default: "user"' required: true - name: auth type: string description: API Key (X-Api-Key) for authentication required: true headers: [] jsonPayloadSchema: type: object required: - type - channel - auth properties: type: type: string default: subscribe description: 'Message type. Default: "subscribe"' x-parser-schema-id: channel: type: string default: user description: 'Channel type. Default: "user"' x-parser-schema-id: auth: type: string description: API Key (X-Api-Key) for authentication x-parser-schema-id: x-parser-schema-id: SubscribeUserMessage title: Subscribe to User Channel description: Subscribe to receive updates about your own orders and transactions example: |- { "type": "subscribe", "channel": "user", "auth": "your-api-key-here" } bindings: [] extensions: - id: x-parser-unique-object-id value: publish.message.0 - &ref_7 id: publish.message.1 contentType: application/json payload: - name: Unsubscribe from User Channel description: Unsubscribe from user channel updates type: object properties: - name: type type: string description: 'Message type. Default: "unsubscribe"' required: true - name: channel type: string description: 'Channel type. Default: "user"' required: true headers: [] jsonPayloadSchema: type: object required: - type - channel properties: type: type: string default: unsubscribe description: 'Message type. Default: "unsubscribe"' x-parser-schema-id: channel: type: string default: user description: 'Channel type. Default: "user"' x-parser-schema-id: x-parser-schema-id: UnsubscribeUserMessage title: Unsubscribe from User Channel description: Unsubscribe from user channel updates example: |- { "type": "unsubscribe", "channel": "user" } bindings: [] extensions: - id: x-parser-unique-object-id value: publish.message.1 bindings: [] extensions: &ref_3 - id: x-parser-unique-object-id value: user - &ref_5 id: user.subscribe title: User.subscribe type: send messages: - &ref_8 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_9 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_10 id: subscribe.message.2 contentType: application/json payload: - name: User Update description: Update about user orders or transactions type: object properties: - name: msg_type type: string description: 'Message type. Default: "order-info"' required: false - name: order_id type: integer description: Order ID (unique identifier for the order) required: false - name: trade_type type: string description: 'Trade type. Default: "order.filled"' examples: &ref_0 - order.filled - order.partially_filled - order.placed - order.cancelled required: false - name: user_id type: string description: User ID required: false - name: event_id type: string description: Event ID required: false - name: market_id type: string description: Market ID required: false - name: side type: string description: 'Order side. Default: "BUY"' examples: &ref_1 - BUY - SELL required: false - name: contract_type type: string description: 'Contract type. Default: "YES"' examples: &ref_2 - 'YES' - 'NO' required: false - name: price type: integer description: Transaction price in ticks required: false - name: quantity type: integer description: Number of contracts required: false - name: transaction_fee type: integer description: Transaction fee in cents required: false headers: [] jsonPayloadSchema: type: object properties: msg_type: type: string description: 'Message type. Default: "order-info"' x-parser-schema-id: order_id: type: integer description: Order ID (unique identifier for the order) x-parser-schema-id: trade_type: type: string default: order.filled description: 'Trade type. Default: "order.filled"' examples: *ref_0 x-parser-schema-id: user_id: type: string description: User ID 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: side: type: string default: BUY description: 'Order side. Default: "BUY"' examples: *ref_1 x-parser-schema-id: contract_type: type: string default: 'YES' description: 'Contract type. Default: "YES"' examples: *ref_2 x-parser-schema-id: price: type: integer description: Transaction price in ticks x-parser-schema-id: quantity: type: integer description: Number of contracts x-parser-schema-id: transaction_fee: type: integer description: Transaction fee in cents x-parser-schema-id: x-parser-schema-id: UserUpdateMessage title: User Update description: Update about user orders or transactions example: |- { "msg_type": "order-info", "trade_type": "order.filled", "user_id": "user-123", "event_id": "event-456", "market_id": "market-789", "side": "BUY", "contract_type": "YES", "price": 40, "quantity": 10, "transaction_fee": 10 } bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe.message.2 bindings: [] extensions: *ref_3 sendOperations: - *ref_4 receiveOperations: - *ref_5 sendMessages: - *ref_6 - *ref_7 receiveMessages: - *ref_8 - *ref_9 - *ref_10 extensions: - id: x-parser-unique-object-id value: user securitySchemes: [] ````