Skip to main content
This topic will notify whenever an order is opened, canceled or a trade happens for the given pair (BASE_QUOTE). By default, the system notifies the topic every 30 seconds, even if a transaction has not taken place. Each side will contain up to 100 orders. Level 3 order book provides individual order details, allowing you to see each order in the book.

​
Subscription Request

​
method
string
required
Subscribe method. Must be subscribe
​
topics
array
required
Array of topics to subscribe to. Format: orderbook/level_3@BASE_QUOTEExample: ["orderbook/level_3@ETH_BRL"]

​
Stream Response

​
id
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.
​
topic
string
Topic name (format: orderbook/level_3@BASE_QUOTE)
​
timestamp
integer
Timestamp in milliseconds
​
body
object
Order book details object

​
Subscription Example

{
  "method": "subscribe",
  "topics": [
    "orderbook/level_3@ETH_BRL"
  ]
}

​
Stream Response Example

{
  "id": 2,
  "topic": "orderbook/level_3@ETH_BRL",
  "timestamp": 1672857013503,
  "body": {
    "pair": "ETH_BRL",
    "hash": "2254383345",
    "asks": [
      {
        "id": "43758DB1-3257-4C98-A20F-7F246E460A50",
        "price": 20,
        "amount": 184.9
      },
      {
        "id": "4B86ACC5-76B2-4003-AF20-F398CE9EDC92",
        "price": 20,
        "amount": 10
      }
    ],
    "bids": [
      {
        "id": "B075FDF9-9B68-4299-87E0-5FC8B40B3ABD",
        "price": 5,
        "amount": 400
      },
      {
        "id": "606763A5-4B95-4216-9F07-69C6B51D64F0",
        "price": 5,
        "amount": 20
      }
    ]
  }
}

​
Update Frequency

  • Default: Every 30 seconds
  • On Change: Immediately when an order is opened, canceled, or a trade happens
  • Updates Include: Both sides of the order book (asks and bids)

​
Key Characteristics

  • Level 3: Shows individual orders, not aggregated by price
  • Up to 100 Orders: Each side contains maximum 100 orders
  • Hash Value: Used to verify order book integrity
  • Order IDs: Each order has a unique identifier
  • Full Depth: Full order book depth is provided in each update

​
Usage Notes

  • Order Tracking: You can track individual orders by their IDs
  • Market Depth: See the complete market depth with individual orders
  • Price Levels: Multiple orders can exist at the same price level
  • Hash Verification: Use the hash to verify the order book hasn’t been corrupted
  • Real-time Updates: Receive immediate updates when orders change

​
Use Cases

  • Order Book Visualization: Display a detailed order book view with individual orders
  • Market Analysis: Analyze individual order patterns and large orders
  • Price Prediction: Track large orders that might indicate market direction
  • Liquidity Analysis: Monitor order liquidity at different price levels
  • Order Tracking: Track specific orders through their complete lifecycle