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

Edit Subscribing to public channels paragraph in README.md.

Browse Source
This commit is contained in:
Davide Casale
2023-04-07 00:54:41 +02:00
parent 2d0fabde20
commit 7a9a57e878
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -128,7 +128,7 @@ Users can close the connection with the WebSocket server using `BfxWebSocketClie
await bfx.wss.close() await bfx.wss.close()
``` ```
A custom [close code number](https://www.iana.org/assignments/websocket/websocket.xhtml#close-code-number) (along with a verbose reason) can be given as a parameter: A custom [close code number](https://www.iana.org/assignments/websocket/websocket.xhtml#close-code-number), along with a verbose reason, can be given as parameters:
```python ```python
await bfx.wss.close(code=1001, reason="Going Away") await bfx.wss.close(code=1001, reason="Going Away")
``` ```
@@ -147,6 +147,14 @@ Users can subscribe to public channels using `BfxWebSocketClient::subscribe`:
await bfx.wss.subscribe("ticker", symbol="tBTCUSD") await bfx.wss.subscribe("ticker", symbol="tBTCUSD")
``` ```
On each successful subscription, the client will emit the `subscribed` event:
```python
@bfx.wss.on("subscribed")
def on_subscribed(subscription: subscriptions.Subscription):
if subscription["channel"] == "ticker":
print(f"{subscription['symbol']}: {subscription['subId']}") # tBTCUSD: 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. \