Perps Trading Gateway

Detailed reference for endpoints, authentication, channels, messages, environment endpoints, and data models in this integration area.

AsyncAPI referencev0.1.0Perpetuals

Omen Perps Gateway WebSocket API

Client-facing trading and account-stream WebSocket API for Omen perps. Clients connect to a single WebSocket endpoint and exchange MessagePack-encoded messages. Examples in this document are shown in JSON for readability, but the wire format is MessagePack maps. The normal first application message is `auth`, but the gateway does not require it to be literally first on the wire. Trading commands and wallet-scoped sub

Environment endpoints

testwss://ws.perps.test.omen.trade/Public test gateway

localws://localhost:8080/Local development gateway

Channels and messages

gatewayConnection

41 messages

Single WebSocket connection used for authentication, trading commands, and wallet-scoped account subscriptions.

AuthCommandSubscribeCommandUnsubscribeCommandPlaceOrderCommandCancelOrderCommandCancelAllOrdersCommandKillSwitchCommandSetMmpCommandReplaceOrderCommandMassQuoteCommandBatchOrdersCommandGetOrderStatusCommandAuthorizeSessionKeyCommandRevokeSessionKeyCommandPingCommandAuthAckEventSubscribedEventUnsubscribedEventErrorEventOrderAckEventCancelledEventPongEventOrderStatusEventKillSwitchAckEventMmpAckEventMassQuoteAckEventBatchOrdersAckEventDropCopySnapshotEventDropCopyGapEventDropCopyEventSessionKeyAuthorizedEventSessionKeyRejectedEventSessionKeyRevokedEventBalanceUpdateEventPositionSnapshotEventPositionUpdateEventPnlSnapshotEventPnlUpdateEventOrdersSnapshotEventOrderUpdateEventSettlementCorrectionEvent

Data models

WalletAddressHexSignatureWalletScopedChannelOrderSideOrderTypeGatewayErrorTypeGatewayErrorCodeGatewayErrorKeyGatewayErrorMessageTypeAuthCommandPayloadSubscribeCommandPayloadUnsubscribeCommandPayloadPlaceOrderCommandPayloadCancelOrderCommandPayloadCancelAllOrdersCommandPayloadKillSwitchCommandPayloadSetMmpCommandPayloadReplaceOrderCommandPayloadMassQuoteEntryMassQuoteCommandPayloadBatchOrderOperationBatchOrdersCommandPayloadGetOrderStatusCommandPayloadAuthorizeSessionKeyCommandPayloadRevokeSessionKeyCommandPayloadPingCommandPayloadAuthAckEventPayloadSubscribedEventPayloadUnsubscribedEventPayloadErrorEventPayloadOrderAckEventPayloadCancelledEventPayloadPongEventPayloadOrderStatusEventPayloadSessionKeyAuthorizedEventPayloadSessionKeyRejectedEventPayloadSessionKeyRevokedEventPayloadBalanceUpdateEventPayloadPositionDataPositionPnlDataPositionSnapshotEventPayloadPnlSnapshotEventPayloadPositionUpdateEventPayloadPnlUpdateEventPayloadOrderDataOrdersSnapshotEventPayloadOrderUpdateEventPayloadKillSwitchAckEventPayloadMmpAckEventPayloadBatchOrderResultBatchOrdersAckEventPayloadMassQuoteResultMassQuoteAckEventPayloadDropCopyEventDataDropCopySnapshotEventPayloadDropCopyGapEventPayloadDropCopyEventPayloadSettlementCorrectionEventPayload