Subscription Request
string
required
Subscribe method. Must be
subscribearray
required
Array of topics to subscribe to. Format:
trade@BASE_QUOTEExample: ["trade@ETH_BRL", "trade@BTC_BRL"]Stream Response
integer
Each WebSocket message includes a sequential numeric id. Each topic has its own unique sequence, and for private topics, the sequence is unique to each topic and user. It’s important to note that some topics will send a “welcome message”, which will have an id value of -1. Additionally, this sequence may be reset between connections, so be sure to update this value locally whenever you reconnect.
string
Topic name (format:
trade@BASE_QUOTE)integer
Timestamp in milliseconds
object
Trade details object
Subscription Example
Stream Response Example
Multiple Subscriptions Example
Usage Notes
- Real-time Updates: You will receive a notification every time a trade executes on the specified pair
- Multiple Pairs: You can subscribe to multiple trading pairs in a single request
- Maker vs Taker: The response includes information about both sides of the trade:
- Maker: The order that was already in the order book
- Taker: The incoming order that matched with the maker
- Volume Information: Use the
amountandpricefields to calculate trade volume and values
Use Cases
- Trade Feed: Display a real-time feed of all trades for specific pairs
- Market Activity: Monitor market activity and trading volume
- Order Matching: Track when your orders have been executed and matched
- Analytics: Collect trade data for analysis and reporting