Skip to content

Commit

Permalink
Enhancements, Examples, PEP8 and spelling (ericsomdahl#47)
Browse files Browse the repository at this point in the history
* pep8, spelling, examples and improvements

* Standardize if else for api_querys

* Adding to README

* happier readme

* rename helper function and place at bottom of file
  • Loading branch information
cdgriffith authored and ericsomdahl committed Sep 11, 2017
1 parent 5c14c1c commit 0848705
Show file tree
Hide file tree
Showing 3 changed files with 248 additions and 63 deletions.
41 changes: 37 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,46 @@ Tips are appreciated:
* LTC: LaasG9TRa9p32noN2oKUVVqrDFp4Ja1NK3


Example Usage
-------------

```python
from bittrex import Bittrex

my_bittrex = Bittrex(None, None)
my_bittrex.get_markets()
{'success': True, 'message': '', 'result': [{'MarketCurrency': 'LTC', ...
```

To access account methods, an API key for your account is required and can be
generated on the `Settings` then `API Keys` page.
Make sure you save the secret, as it will not be visible
after navigating away from the page.

```python
from bittrex import Bittrex

my_bittrex = Bittrex("<my_api_key>", "<my_api_secret>")

my_bittrex.get_balance('ETH')
{'success': True,
'message': '',
'result': {'Currency': 'ETH', 'Balance': 0.0, 'Available': 0.0,
'Pending': 0.0, 'CryptoAddress': None}
}
```


Testing
-------


In order to run the integration tests, a file called "secrets.json" must be added to the test folder.
Structure it as follows, adding your API keys:
<pre>
<code>

```json
{
"key": "mykey",
"secret": "mysecret"
}
</code>
</pre>
```
Loading

0 comments on commit 0848705

Please sign in to comment.