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

Add Unsubscribing from a public channel sub-paragraph to README.md.

Browse Source
This commit is contained in:
Davide Casale
2023-04-08 03:27:17 +02:00
parent 7a9a57e878
commit 4a9c9b1ac7
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -52,6 +52,7 @@ python3 -m pip install bitfinex-api-py==3.0.0b1
2. [Running the client](#running-the-client) 2. [Running the client](#running-the-client)
* [Closing the connection](#closing-the-connection) * [Closing the connection](#closing-the-connection)
3. [Subscribing to public channels](#subscribing-to-public-channels) 3. [Subscribing to public channels](#subscribing-to-public-channels)
* [Unsubscribing from a public channel](#unsubscribing-from-a-public-channel)
* [Setting a custom `sub_id`](#setting-a-custom-sub_id) * [Setting a custom `sub_id`](#setting-a-custom-sub_id)
4. [Listening to events](#listening-to-events) 4. [Listening to events](#listening-to-events)
5. [Advanced Features](#advanced-features) 5. [Advanced Features](#advanced-features)
@@ -155,6 +156,16 @@ def on_subscribed(subscription: subscriptions.Subscription):
print(f"{subscription['symbol']}: {subscription['subId']}") # tBTCUSD: f2757df2-7e11-4244-9bb7-a53b7343bef8 print(f"{subscription['symbol']}: {subscription['subId']}") # tBTCUSD: f2757df2-7e11-4244-9bb7-a53b7343bef8
``` ```
### Unsubscribing from a public channel
It is possible to unsubscribe from a public channel at any time. \
Unsubscribing from a public channel prevents the client from receiving any more data from it. \
This can be done using `BfxWebSocketClient::unsubscribe`, and passing the `sub_id` of the public channel you want to unsubscribe from:
```python
await bfx.wss.unsubscribe(sub_id="f2757df2-7e11-4244-9bb7-a53b7343bef8")
```
### Setting a custom `sub_id` ### Setting a custom `sub_id`
The client generates a random `sub_id` for each subscription. \ The client generates a random `sub_id` for each subscription. \