23 lines
1.7 KiB
Markdown
23 lines
1.7 KiB
Markdown
# 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:
|
|
|
|
|
|
|
|
This document descibres the API layer between the exchange wrappers and Gekko Broker.
|
|
|
|
## Wrapper API spec
|
|
|
|
The current API documentation is currently located [here](../extending/add_an_exchange.md).
|
|
|
|
## 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](https://forum.gekko.wizb.it/thread-57279-post-59207.html) 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](https://github.com/askmike/gekko/commit/0e301f7d66e24ec97327f5f01380f691cc2d3725#diff-dbfe320ca090e208be32459d98fc11ed).
|
|
- checkOrder now expects an object with a few properties to be returned, see [details](https://github.com/askmike/gekko/commit/e0d4a7362cd74b4b4f50759b1012ce489ea44a0c#diff-dbfe320ca090e208be32459d98fc11ed).
|
|
- 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](https://github.com/askmike/gekko/commit/e0d4a7362cd74b4b4f50759b1012ce489ea44a0c#diff-dbfe320ca090e208be32459d98fc11ed).
|