Skip to main content

High-frequency trading and market making backtesting tool

Project description

|Codacy |CodeQL |Package Version |Downloads |License

High-Frequency Trading Backtesting Tool in Python

This Python 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.

Key Features

  • Working in Numba JIT function.

  • Complete tick-by-tick simulation with a variable time interval.

  • Full order book reconstruction based on L2 feeds(Market-By-Price).

  • Backtest accounting for both feed and order latency, using provided models or your own custom model.

  • Order fill simulation that takes into account the order queue position, using provided models or your own custom model.

Getting started

Installation

hftbacktest supports Python 3.7+. You can install hftbacktest using pip:

pip install hftbacktest

Or you can clone the latest development version from the Git repository with:

git clone https://github.com/nkaz001/hftbacktest

Data Source & Format

Please see Data or Data Preparation.

A Quick Example

Get a glimpse of what backtesting with hftbacktest looks like with these code snippets:

@njit
def simple_two_sided_quote(hbt, stat):
    max_position = 5
    half_spread = hbt.tick_size * 20
    skew = 1
    order_qty = 0.1
    last_order_id = -1

    bid_order_price_tick_as_id = -1
    ask_order_price_tick_as_id = -1

    while hbt.run:
        # Check every 0.1s
        if not hbt.elapse(0.1 * 1e6):
            return False

        # Clear cancelled, filled or expired orders.
        hbt.clear_inactive_orders()

        # Obtain the current mid-price and compute the reservation price.
        mid_price = (hbt.best_bid + hbt.best_ask) / 2.0
        reservation_price = mid_price - skew * hbt.position * hbt.tick_size

        bid_order_price = reservation_price - half_spread
        ask_order_price = reservation_price + half_spread

        # Cancel the existing bid order.
        existing_bid_order = hbt.orders.get(bid_order_price_tick_as_id)
        if existing_bid_order is not None and existing_bid_order.cancellable:
            hbt.cancel(existing_bid_order.order_id)
            last_order_id = existing_bid_order.order_id

        # Cancel the existing ask order.
        existing_ask_order = hbt.orders.get(ask_order_price_tick_as_id)
        if existing_ask_order is not None and existing_ask_order.cancellable:
            hbt.cancel(existing_ask_order.order_id)
            last_order_id = existing_ask_order.order_id

        if hbt.position < max_position:
            # Submit a new post-only limit bid order.
            bid_order_price_tick_as_id = round(bid_order_price / hbt.tick_size)
            hbt.submit_buy_order(
                bid_order_price_tick_as_id,
                bid_order_price,
                order_qty,
                GTX
            )
            last_order_id = bid_order_price_tick_as_id

        if hbt.position > -max_position:
            # Submit a new post-only limit ask order.
            ask_order_price_tick_as_id = round(ask_order_price / hbt.tick_size)
            hbt.submit_sell_order(
                ask_order_price_tick_as_id,
                ask_order_price,
                order_qty,
                GTX
            )
            last_order_id = ask_order_price_tick_as_id

        # All order requests are considered to be requested at the same time.
        # Wait until one of the order responses is received.
        if last_order_id >= 0:
            hbt.wait_order_response(last_order_id)

        # Record the current state for stat calculation.
        stat.record(hbt)
    return True

Examples

You can find more examples in examples directory.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hftbacktest-1.5.0.tar.gz (28.3 kB view details)

Uploaded Source

File details

Details for the file hftbacktest-1.5.0.tar.gz.

File metadata

  • Download URL: hftbacktest-1.5.0.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.5

File hashes

Hashes for hftbacktest-1.5.0.tar.gz
Algorithm Hash digest
SHA256 2960ed939fe93ad0907dccb7d39180c83461bd1ba688b54b58c6767245420b75
MD5 910275739350ae47a7d100e56ea49215
BLAKE2b-256 709ce9a6dcebedf931bbfbcb9efa915212b9af26c19e88e935dec00a87f8e153

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page