Skip to main content

​
Subscribe

​
Request Body

ParameterTypeDescription
method*stringMust be "subscribe"
subscription*objectSee below
subscription.type*stringMust be "userTransactions"
subscription.user*stringYour wallet address (lowercase), e.g., "0x742d35cc6634c0532925a3b844bc9e7595f0beb"

​
Response

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

​
Transaction Fields

FieldTypeDescription
transactionIdstringUnique transaction hash
typestringTransaction type (see table below)
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
OrderCanceledOrder canceled by user
OrderFilledOrder executed (partial or complete)
DepositFunds deposited to account
WithdrawalFunds withdrawn from account
TransferInternal transfer between accounts
FundingPaymentFunding rate payment
InterestPaymentInterest charged on borrowed funds
LiquidationPosition liquidated
PositionModifiedPosition take-profit/stop-loss updated

​
Type-Specific Data

​
OrderPlaced

{
  "type": "OrderPlaced",
  "orderId": "0x5678...",
  "data": {
    "coin": "BTC",
    "side": "B",
    "limitPx": "50000.00",
    "sz": "0.1"
  }
}

​
OrderFilled

{
  "type": "OrderFilled",
  "orderId": "0x5678...",
  "data": {
    "coin": "BTC",
    "filledSz": "0.05",
    "avgPx": "50000.00",
    "fee": "2.50"
  }
}

​
Deposit

{
  "type": "Deposit",
  "data": {
    "asset": "USDC",
    "amount": "1000.00",
    "txHash": "0xabcd..."
  }
}

​
Withdrawal

{
  "type": "Withdrawal",
  "data": {
    "asset": "USDC",
    "amount": "500.00",
    "destination": "0x9876...",
    "txHash": "0xefgh..."
  }
}

​
FundingPayment

{
  "type": "FundingPayment",
  "data": {
    "coin": "BTC",
    "amount": "-1.25",
    "rate": "0.0001"
  }
}

​
Unsubscribe

{
  "method": "unsubscribe",
  "subscription": {
    "type": "userTransactions",
    "user": "0x742d35cc6634c0532925a3b844bc9e7595f0beb"
  }
}

​
Notes

  • Transactions sent in real-time as they occur
  • User address must be lowercase
  • Transaction data structure varies by type