mirror of
https://github.com/aljazceru/bitfinex-api-py.git
synced 2026-01-08 16:34:19 +01:00
4f43d547952ce7aa5f2b1d62910e952121077c0e
bitfinex-api-py (v3-beta)
Official implementation of the Bitfinex APIs (V2) for Python 3.8+.
DISCLAIMER:
Production use of v3.0.0b1 (and all future beta versions) is HIGHLY discouraged.
Beta versions should not be used in applications which require user authentication.
Provide your API-KEY/API-SECRET, and manage your account and funds at your own risk.
Features
- User-friendly implementations for 75+ public and authenticated REST endpoints.
- A complete list of available REST endpoints can be found here.
- New WebSocket client to ensure fast, secure and persistent connections.
- Support for all public channels + authenticated events and inputs (a list can be found here).
- Automatic reconnection system in case of network fail (both client and server side).
- The WebSocket client logs every reconnection failure, success and attempt (as well as other events).
- Connection multiplexing to allow subscribing to a large number of public channels (without affecting performances).
- The WebSocket server sets a limit of 25 subscriptions per connection, connection multiplexing allows the WebSocket client to bypass this limit.
- Full type-hinting and type-checking support with
mypy.
- Installation
- Basic Usage
- Getting started with the WebSocket client
- Building the source code
- How to contribute
Installation
To install the latest beta release of bitfinex-api-py:
python3 -m pip install --pre bitfinex-api-py
Otherwise, to install a specific beta version:
python3 -m pip install bitfinex-api-py==3.0.0b1
Basic usage
Getting started with the WebSocket client
Authentication with API-KEY and API-SECRET
Configure the WebSocket client logger
Building the source code
Testing (with unittest)
Linting the project with pylint
Using mypy to ensure correct type-hinting
How to contribute
License
This project is released under the Apache License 2.0.
The complete license can be found here: https://www.apache.org/licenses/LICENSE-2.0.
Description
Languages
Python
100%
