Skip to main content

Subscribe

Request Body

ParameterTypeDescription
method*stringMust be "subscribe"
subscription*objectSee below
subscription.type*stringMust be "newTransactions"
Note: No user parameter required for global subscriptions.

Response

Subscription Confirmation:
{
  "channel": "subscriptionResponse",
  "data": {
    "method": "subscribe",
    "subscription": {
      "type": "newTransactions"
    }
  }
}
Transaction Notification:
{
  "channel": "newTransactions",
  "data": {
    "transactionId": "0x1234...",
    "type": "OrderPlaced",
    "timestamp": 1701234567890,
    "blockNumber": 12345,
    "txIndex": 0,
    "orderId": "0x5678...",
    "data": {}
  }
}

Transaction Fields

FieldTypeDescription
transactionIdstringUnique transaction hash
typestringTransaction type
timestampnumberTransaction time in milliseconds
blockNumbernumberBlock containing transaction
txIndexnumberTransaction index within block
orderIdstringRelated order ID (if applicable)
dataobjectType-specific transaction data

Transaction Types

TypeDescription
OrderPlacedNew order submitted to system
OrderCanceledOrder canceled
OrderFilledOrder executed
DepositFunds deposited
WithdrawalFunds withdrawn
TransferInternal transfer
FundingPaymentFunding rate payment
InterestPaymentInterest payment
LiquidationPosition liquidation
PositionModifiedPosition TP/SL updated

Unsubscribe

{
  "method": "unsubscribe",
  "subscription": {
    "type": "newTransactions"
  }
}

Notes

  • Global subscription - no user address required
  • High volume stream - can produce many messages per second
  • Includes all system transactions
  • Consider client-side filtering for performance