mirror of
https://github.com/aljazceru/bitfinex-api-py.git
synced 2025-12-19 23:04:21 +01:00
regen docs
This commit is contained in:
committed by
Jacob Plaster
parent
f974268d7a
commit
7b3700f619
@@ -11,7 +11,7 @@ bfx = Client(
|
|||||||
API_KEY=API_KEY,
|
API_KEY=API_KEY,
|
||||||
API_SECRET=API_SECRET,
|
API_SECRET=API_SECRET,
|
||||||
logLevel='DEBUG',
|
logLevel='DEBUG',
|
||||||
dead_man_switch=true, # <-- kill all orders if this connection drops
|
dead_man_switch=True, # <-- kill all orders if this connection drops
|
||||||
channel_filter=['wallet'] # <-- only receive wallet updates
|
channel_filter=['wallet'] # <-- only receive wallet updates
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -9,14 +9,14 @@ a websocket client and a rest interface client
|
|||||||
|
|
||||||
## Client
|
## Client
|
||||||
```python
|
```python
|
||||||
Client(self, API_KEY=None, API_SECRET=None, rest_host='https://test.bitfinex.com/v2', ws_host='wss://test.bitfinex.com/ws/2', create_event_emitter=None, logLevel='INFO', dead_man_switch=False, ws_capacity=25, *args, **kwargs)
|
Client(self, API_KEY=None, API_SECRET=None, rest_host='https://api-pub.bitfinex.com/v2', ws_host='wss://api-pub.bitfinex.com/ws/2', create_event_emitter=None, logLevel='INFO', dead_man_switch=False, ws_capacity=25, channel_filter=[], *args, **kwargs)
|
||||||
```
|
```
|
||||||
|
|
||||||
The bfx client exposes rest and websocket objects
|
The bfx client exposes rest and websocket objects
|
||||||
|
|
||||||
# BfxWebsocket
|
# BfxWebsocket
|
||||||
```python
|
```python
|
||||||
BfxWebsocket(self, API_KEY=None, API_SECRET=None, host='wss://test.bitfinex.com/ws/2', manageOrderBooks=False, dead_man_switch=False, ws_capacity=25, logLevel='INFO', parse_float=<class 'float'>, *args, **kwargs)
|
BfxWebsocket(self, API_KEY=None, API_SECRET=None, host='wss://api-pub.bitfinex.com/ws/2', manageOrderBooks=False, dead_man_switch=False, ws_capacity=25, logLevel='INFO', parse_float=<class 'float'>, channel_filter=[], *args, **kwargs)
|
||||||
```
|
```
|
||||||
|
|
||||||
More complex websocket that heavily relies on the btfxwss module.
|
More complex websocket that heavily relies on the btfxwss module.
|
||||||
|
|||||||
Reference in New Issue
Block a user