This project is not maintained anymore.

After many years of working on Gekko, I’ve decided to stop my involvement in maintaining this project. You can read more about this decision on medium.

I’m now putting all my focus on my new prop trading firm Folkvang. You can find an article about that here on Coindesk.

If you’re interested in following this new journey, feel free to add me on Twitter.

Best of luck to everyone in their trading. So long, and thanks for all the fish!

Wrapper API #

Gekko Broker is a library that sits between trading applications and Gekko Broker Exchange Wrappers. Which means it has two APIs to communicate with other code:

diagram describing Gekko Broker API interface

This document descibres the API layer between the exchange wrappers and Gekko Broker.

Wrapper API spec #

The current API documentation is currently located here.

Wrapper API Changelog #

Gekko 0.5.x to Gekko (Broker) 0.6.0 #

NOTE: this API design might still have minor changes leading up to the release of Gekko 0.6. See this thread for more information.

The wrapper files are now nested different (from gekko/exchanges to gekkobroker/wrappers (which equals gekko/exchange/wrappers for Gekko users).
cancelOrder now requires a second parameter to be passed (that indicates whether the order was filled before it was canceled), see details.
checkOrder now expects an object with a few properties to be returned, see details.
Error handling has gotten a lot more complex, with an updated error interface between a retry system (provided by Gekko) and the exchange wrapper. Read more here.