Skip to content

Commit fb51be5

Browse files
committed
docs: Refine README to highlight features including TWAP Detector
1 parent 61418ee commit fb51be5

1 file changed

Lines changed: 17 additions & 23 deletions

File tree

README.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,29 @@
22

33
![Demo GIF](demo2.gif)
44

5-
This project is a high-performance real-time visualization tool for the Binance perpetual swap order book. It leverages **Execution-Aware Queue Dynamics (EAQD)** to estimate a Level 3 (L3) order book microstructure from Level 2 (L2) events and real-time trade streams, providing deep insights into order queue seniority and market participant behavior.
5+
This project is a high-performance real-time visualization tool for the Binance perpetual swap order book. It estimates a Level 3 (L3) order book from Level 2 (L2) data streams to give you deep insights into market liquidity, order queue seniority, and participant behavior.
66

77
## Key Features
88

9-
* **Real-time Data Architecture**: Low-latency streaming of order book depth and trade events via Binance WebSocket API.
10-
* **Advanced L3 Estimation**: Moves beyond naive estimation to account for execution priority, cancellation behavior, and market regime.
11-
* **Microstructure Metrics Panel**: Dedicated real-time dashboard for high-resolution microstructure health indicators.
12-
* **Order-to-Trade Ratio (OTR)**: Tracks liquidity provision intensity at Top-1 and Top-20 levels.
13-
* **Cancellation-to-Trade Ratio (CTR)**: Monitors cancellation/spoofing velocity across sides.
14-
* **Dynamic Heatmap Visualization**: Standardized depth heatmap using Z-score normalization with interactive controls.
15-
* **Interactive Analytics**: Sweep/Liquidity-Cost windows with right-click drag-to-zoom and multi-axis rendering.
16-
* **K-Means Clustering**: Real-time classification of market participants based on order size and arrival patterns.
9+
* **Real-time Order Book Heatmap**
10+
Visualize market depth with a dynamic heatmap. Easily spot liquidity clusters and identify major support and resistance levels.
11+
12+
* **Interactive Analytics & Zooming**
13+
Analyze the market with multi-axis rendering. Right-click and drag on liquidity charts to zoom into specific price ranges for precise inspection of the order book.
1714

18-
## Technical Core
15+
* **Microstructure Health Dashboard**
16+
Monitor market health in real-time with a dedicated dashboard displaying key indicators:
17+
* **Order-to-Trade Ratio (OTR)** to track liquidity provision density.
18+
* **Cancellation-to-Trade Ratio (CTR)** to spot cancellation velocity and potential spoofing.
1919

20-
The estimator utilizes several proprietary techniques to maintain a ground-truth-aligned L3 view:
20+
* **Market Participant Clustering**
21+
Automatically classify market participants in real-time. The tool uses K-Means clustering based on order sizes and trading frequencies to help you identify distinct trading behaviors.
2122

22-
### 1. Execution-Aware Queue Dynamics (EAQD)
23-
Refined logic for inflow and outflow handling. Unlike static models, EAQD understands the difference between fills (FIFO consumption) and cancellations (LIFO/Priority-based reduction).
23+
* **Algorithmic TWAP Detector**
24+
Spot hidden execution algorithms (Time-Weighted Average Price bots) in the market. The tool analyzes trade streams to identify distinct buy and sell side periodic trading patterns, revealing execution frequency and estimated volume limits.
2425

25-
### 2. Deep Depth Fragmentation (DWF)
26-
Also known as Statistical Order Flow Profiling (SOFP). This system fragments large L2 liquidity additions into multiple virtual orders based on a rolling distribution of market trade sizes.
27-
* **Whale Bypass**: If an addition is extremely large (e.g., > 20x average trade size), the system bypasses fragmentation, treating it as a single high-conviction "Whale" order.
28-
* **Robust Multi-Order Cancellation**: Combined with EAQD, the system now handles large LIFO cancellations that span multiple fragments, ensuring accurate queue reduction even when fragmented blocks are removed.
29-
30-
### 3. Marker-Triggered Queue Refining (MTQR)
31-
Integrates the `@trade` stream as a synchronization pulse. When a trade occurs at a specific price, MTQR validates the maker's size against our estimated queue. If a trade exceeds our front-of-queue estimate, the model "snaps" to the ground truth and adjusts seniority accordingly.
32-
33-
### 4. Seniority Decay & Priority Reset
34-
Handles partial fills and order modifications. Partial fills retain their queue position, while modifications that increase size or change price trigger a priority reset, accurately reflecting exchange matching engine logic.
26+
* **Advanced Order Queue Tracking**
27+
Get a highly accurate representation of the L3 order book. The tool intelligently tracks order priorities, partial fills, multi-order cancellations, and explicitly highlights massive "Whale" orders.
3528

3629
## Usage
3730

@@ -52,6 +45,7 @@ Ensure you have Rust installed ([rust-lang.org](https://www.rust-lang.org)).
5245

5346
#### UI Controls
5447
* **Microstructure Toggle**: Use the UI panel to enable/disable the OTR/CTR dashboard.
48+
* **TWAP Toggle**: Open the TWAP Detector window to monitor periodic trading activity.
5549
* **Heatmap Z-Score**: Adjust the standardization slider to highlight liquidity outliers.
5650
* **Zoom**: Right-click and drag on the liquidity charts to inspect specific price ranges.
5751

0 commit comments

Comments
 (0)