Welcome to Stockfighter’s documentation!¶
Stockfighter¶
API wrapper for Stockfighter
- Free software: ISC license
- Limited documentation exists at: https://stockfighter.readthedocs.org. Happily accepting patches to improve it!
Get things started¶
Not hard!
pip install stockfighter
Using the standard API
from stockfighter import Stockfighter
s = Stockfighter(venue='TESTEX', account='EXB123456', api_key='123456')
print(s.venue_stocks())
...and the GM API for managing levels and such
from stockfighter import GM
gm = GM(api_key=123456)
print gm.start('first_steps') # Start the first level programmatically
For simplicity (and so you can share your code!) the GM and Stockfighter clients will also default to reading api keys from the environment variable API_KEY, if none was passed.
Features¶
- Calling the core Stockfighter API is pretty important :)
- Includes some rudimentary support for the GM API, such as it is known
- .....get back to me later on what else