Skip to content

Commit 7ec9234

Browse files
committed
docs: add a new example.
1 parent c9c0a06 commit 7ec9234

File tree

4 files changed

+872
-3
lines changed

4 files changed

+872
-3
lines changed

README.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ HftBacktest
77
High-Frequency Trading Backtesting Tool
88
=======================================
99

10-
This framework is designed for developing high-frequency trading and market-making strategies. It focuses on accounting for both feed and order latencies, as well as the order queue position for order fill simulation. The framework aims to provide more accurate market replay-based backtesting, based on full order book and trade tick feed data.
10+
This framework is designed for developing high frequency trading and market making strategies. It focuses on accounting for both feed and order latencies, as well as the order queue position for order fill simulation. The framework aims to provide more accurate market replay-based backtesting, based on full order book and trade tick feed data.
1111

1212
Key Features
1313
============
@@ -171,6 +171,7 @@ Tutorials
171171
* `Level-3 Backtesting <https://hftbacktest.readthedocs.io/en/latest/tutorials/Level-3%20Backtesting.html>`_
172172
* `Market Making with Alpha - Order Book Imbalance <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20Order%20Book%20Imbalance.html>`_
173173
* `Market Making with Alpha - Basis <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20Basis.html>`_
174+
* `Market Making with Alpha - APT <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20APT.html>`_
174175
* `Queue-Based Market Making in Large Tick Size Assets <https://hftbacktest.readthedocs.io/en/latest/tutorials/Queue-Based%20Market%20Making%20in%20Large%20Tick%20Size%20Assets.html>`_
175176

176177
Examples

ROADMAP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,6 @@
6161
* [ ] Example demonstrating latency-aware actions.
6262
* [ ] Example demonstrating the volume clock/event clock using `wait_next_feed`.
6363
* [ ] Example demonstrating the cross-market market-making.
64-
* [ ] Market making with alpha from the perspectives of statistical arbitrage and optimal execution.
64+
* [X] Market making with alpha from the perspectives of statistical arbitrage and optimal execution.
6565
* [X] Queue-position-based market making for large-tick assets.
6666
* [X] Update the existing examples to align with version 2.0.0.

docs/index.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ HftBacktest
1010
High-Frequency Trading Backtesting Tool
1111
=======================================
1212

13-
This framework is designed for developing high-frequency trading and market-making strategies. It focuses on accounting for both feed and order latencies, as well as the order queue position for order fill simulation. The framework aims to provide more accurate market replay-based backtesting, based on full order book and trade tick feed data.
13+
This framework is designed for developing high frequency trading and market making strategies. It focuses on accounting for both feed and order latencies, as well as the order queue position for order fill simulation. The framework aims to provide more accurate market replay-based backtesting, based on full order book and trade tick feed data.
1414

1515
Key Features
1616
============
@@ -174,6 +174,7 @@ Tutorials
174174
* `Level-3 Backtesting <https://hftbacktest.readthedocs.io/en/latest/tutorials/Level-3%20Backtesting.html>`_
175175
* `Market Making with Alpha - Order Book Imbalance <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20Order%20Book%20Imbalance.html>`_
176176
* `Market Making with Alpha - Basis <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20Basis.html>`_
177+
* `Market Making with Alpha - APT <https://hftbacktest.readthedocs.io/en/latest/tutorials/Market%20Making%20with%20Alpha%20-%20APT.html>`_
177178
* `Queue-Based Market Making in Large Tick Size Assets <https://hftbacktest.readthedocs.io/en/latest/tutorials/Queue-Based%20Market%20Making%20in%20Large%20Tick%20Size%20Assets.html>`_
178179

179180
Examples
@@ -264,6 +265,7 @@ Please see the `roadmap <https://github.com/nkaz001/hftbacktest/blob/master/ROAD
264265
tutorials/Level-3 Backtesting
265266
tutorials/Market Making with Alpha - Order Book Imbalance
266267
tutorials/Market Making with Alpha - Basis
268+
tutorials/Market Making with Alpha - APT
267269
tutorials/Queue-Based Market Making in Large Tick Size Assets
268270
tutorials/examples
269271

examples/Market Making with Alpha - APT.ipynb

+866
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)