Skip to content

Latest commit

 

History

History
96 lines (51 loc) · 1.84 KB

README.md

File metadata and controls

96 lines (51 loc) · 1.84 KB
Raw

Bitfinex Python Client

A Python client for the Bitfinex API.

Most of the unauthenticated calls have been implemented. It is planned to implement the remainder of the API.

Installation

pip install bitfinex

Poll The Order Book

Run the bitfinex-poll-orderbook script in a terminal.

Press Ctrl-c to exit.

bitfinex-poll-orderbook

Setup

Install the libs

pip install -r ./requirements.txt

Tests

Depending on your system, install one of the following libs

  • pyinotify (Linux)
  • pywin32 (Windows)
  • MacFSEvents (OSX)

Sniffer will watch for changes

sniffer -x --nocapture

Or Sniffer with code coverage enabled...

sniffer -x --nocapture -x--with-coverage -x--cover-html -x--cover-package=bitfinex

Or you can just run the tests

nosetests

Test Coverage

Test coverage of the code. View cover/index.html to view detailed reports.

nosetests --with-coverage --cover-html --cover-package bitfinex

Usage

See the examples directory for samples.

e.g.

PYTHONPATH=.:$PYTHONPATH python examples/basic.py

Compatibility

This code has been tested on

  • Python 2.7.5
  • Python 3.3.1

TODO

  • Implement all API calls that Bitfinex make available.

Contributing

  1. Create an issue and discuss.
  2. Fork it.
  3. Create a feature branch containing only your fix or feature.
  4. Add tests!!!! Features or fixes that don't have good tests won't be accepted.
  5. Create a pull request.

References

Licence

The MIT License (MIT)

Copyright (c) 2014-2015 Scott Barr

See LICENSE.md