aljaz/bitfinex-api-py
1
0
Fork 0
mirror of https://github.com/aljazceru/bitfinex-api-py.git synced 2025-12-24 01:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #28 from straussmaximilian/readme

Browse Source 
Update README.md
This commit is contained in:
Jacob Plaster
2019-09-24 11:52:30 +01:00
committed by GitHub
parent 527ef2e0d3 ff817c012c
commit 70f7ad1108
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -21,16 +21,27 @@ bfx.ws.run()
# Bitfinex Trading API for Python. Bitcoin, Ether and Litecoin trading
This is an official python library that is used to connect interact with the Bitfinex api. Currently it only has support for websockets but will soon have Rest functionality as well.
This is an official python library that is used to connect interact with the Bitfinex api. Currently, it only has support for websockets but will soon have Rest functionality as well.
Install dependencies
## Installation
Clone package:
```sh
git clone https://github.com/bitfinexcom/bitfinex-api-py.git
cd bitfinex-api-py
```
Install dependencies:
```sh
pip3 install -r requirements.txt
```
Install package:
```sh
python3 setup.py install
```
Run the trades/candles example:
```sh
cd bfxapi/examples
python3 subsribe_trades_candles.py
cd bfxapi/examples/ws
python3 subscribe_trades_candles.py
```
# Features