francois/gekko
Archived
1
0 Fork 0
Code Issues Releases Wiki Activity
This repository has been archived on 2025-10-29. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
aa7869eb3380557803398e9d31400a9be826e47d
gekko/docs/gekko-broker/wrapper_api.md
T
Francois Klieber aa7869eb33 first commit
2021-06-06 20:25:14 +02:00

1.7 KiB
Raw Blame History

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.
Reference in new issue View Git Blame Copy Permalink