Skip to content

Commit

Permalink
reformat the README file using markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Crosby committed Sep 3, 2012
1 parent 88ea6b5 commit 5eca9dc
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
# optionshouse-api-client
optionshouse-api-client is a simple python wrapper around the optionshouse
trading platform API. The goal of this project is to provide a working, but
minimal, non-magic interface to the API.
[http://lithostech.com/2012/09/automated-trading-via-optionshouse-api/](http://lithostech.com/2012/09/automated-trading-via-optionshouse-api/ "lithostech.com")

Disclaimer:
This API client has some test coverage, but has not gone through any real-world
use yet. I would strongly discourage anyone from using this to place real
orders at this time. If you use this software, you must assume all
responsibility for your actions and the actions of this software package.

==Basic Example Session
## Basic Example Session
```python
from session import Session
s = Session('myusername', 'mypassword')
s.open()
s.quote('GS')
s.close()
```

==Placing a Simple Order
## Placing a Simple Order
```python
s = Session('myusername', 'mypassword')
s.open()
order = Order(
Expand All @@ -34,21 +39,24 @@ order = Order(
)
]
)
```

# Just supply your account id and your order object
## Just supply your account id and your order object
```python
s.preview_order(12345, order)
```

# Looks good? Go ahead and place it
## Looks good? Go ahead and place it
s.place_order(12345, order)
s.close()

==Responses
## Responses
All of the API requests have structured responses which vary. Take a look in
the tests folder for some examples.

==Supported API Methods
This API client supports all the documented optionshouse API actions. Each one
is available as a method on instances of Session:
## Supported API Methods
This API client supports all the documented optionshouse API actions. Each one is available as a method on instances of Session:

* account_activity
* account_cash
* account_info
Expand All @@ -65,4 +73,3 @@ is available as a method on instances of Session:
* place_order
* preview_order
* quote

0 comments on commit 5eca9dc

Please sign in to comment.