Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 2.17 KB

README.md

File metadata and controls

44 lines (36 loc) · 2.17 KB
Raw

gdax-army

A repository to provide automatic trading bot to trade $-to-coin on GDAX using gdax-python API.

Maintainers - Johnny Ho, Panayiotis Petousis

Warming

This repository is for non-commercial use and for research purpose. Please use it in caution and it DOES NOT guranttee to earn profit. Please report any bugs.

Contributing

Please feel free to pull requests.

Pull Request Guidelines

  • Please follow as close as pep-0008 coding guidelines, such as having at most 79 characters in a line.
  • REMEMBER to remove your credentials in code everytime before you push to master branch.
  • Code in pythonic way.
  • We follow KISS (Keep it simple, stupid!) for the design principle, and OOP for design pattern.
  • If you are using subl, please auto format it following PEP-8 standard, tutorial.
  • When you write tests, please follow the convention in sampleUnitTest.py.

Code Organization

run.py - the main for all parameters setup.
lib/Trader.py - the core class to handle trading logic.
lib/Strategier.py - the parent class to provides functionalities for buy & sell.
lib/BuyStrategier.py - the child class to provide specific buy strategy.
lib/SellStrategier.py - the child class to provide specific sell strategy.
lib/GdaxArmy.py - the API class for gdax-python, and GDAX authentication.
lib/utils.py - utilities functions.
test/ - unit tests.
logs/ - [DATE]_log.log for comprehensive log and [DATE]_trade.log for precise transaction.
ext/ - experimental python notebooks.

To run

Input your gdax API keys in run.py lines 10-12. And then do:

python run.py

Trading Assumption

  • We provided a good-to-go solution (with buy & sell strategies) for simple trading in GDAX. We assume one-buy-one-sell trading cycle. That is, after one buy, we sell to complete a cycle.

License

The MIT License (MIT)