Skip to main content

Python API

What is the Bookmap Python API?​

The Python API add-on allows you to develop and run Bookmap add-ons. It is intended for developers who prefer using Python over Java. Developers need only a basic knowledge of Python to use this add-on.

You can draw your own custom indicators and automate trades based on order book updates, trades and other events. You can write code directly from Bookmap or use an external IDE (like PyCharm).

Note: The Python API is currently in open beta. It supports all L1 API features, except replay mode.

Requirements​

To run the Python API, you will need.

  • The most recent stable version of Bookmap

  • Python version 3.7.14. Lower versions of Python 3 are not supported, but still may work.

Downloads​

Download the Bookmap Python API:

  • Bookmap 7.4 or greater: install via Bookmap -> Settings -> Manage plugins -> Bookmap Add-ons (L1)

Support​

Detailed user documentation, examples, and a quick start guide for the Bookmap Python API are in its GitHub repository.

Join the Discord #python-api channel for feedback and to request additional features.

Last updated on