mirror of
https://github.com/aljazceru/bitfinex-api-py.git
synced 2025-12-19 14:54:21 +01:00
89 lines
2.6 KiB
Python
89 lines
2.6 KiB
Python
"""
|
|
Module used to describe all of the different data types
|
|
"""
|
|
|
|
import time
|
|
import json
|
|
from random import randint
|
|
|
|
def generate_sub_id():
|
|
"""
|
|
Generates a unique id in the form of 12345566-12334556
|
|
"""
|
|
prefix = str(int(round(time.time() * 1000)))
|
|
suffix = str(randint(0, 9999999))
|
|
return "{}-{}".format(prefix, suffix)
|
|
|
|
class Subscription:
|
|
"""
|
|
Object used to represent an individual subscription to the websocket.
|
|
This class also exposes certain functions which helps to manage the subscription
|
|
such as unsibscribe and subscribe.
|
|
"""
|
|
|
|
def __init__(self, socket, channel_name, symbol, key=None, timeframe=None, **kwargs):
|
|
self.socket = socket
|
|
self.channel_name = channel_name
|
|
self.symbol = symbol
|
|
self.timeframe = timeframe
|
|
self.is_subscribed_bool = False
|
|
self.key = key
|
|
self.chan_id = None
|
|
if timeframe:
|
|
self.key = 'trade:{}:{}'.format(self.timeframe, self.symbol)
|
|
self.sub_id = generate_sub_id()
|
|
self.send_payload = self._generate_payload(**kwargs)
|
|
|
|
def get_key(self):
|
|
"""
|
|
Generates a unique key string for the subscription
|
|
"""
|
|
return "{}_{}".format(self.channel_name, self.key or self.symbol)
|
|
|
|
def confirm_subscription(self, chan_id):
|
|
"""
|
|
Update the subscription to confirmed state
|
|
"""
|
|
self.is_subscribed_bool = True
|
|
self.chan_id = chan_id
|
|
|
|
async def unsubscribe(self):
|
|
"""
|
|
Send an unsubscription request to the bitfinex socket
|
|
"""
|
|
if not self.is_subscribed():
|
|
raise Exception("Subscription is not subscribed to websocket")
|
|
payload = {'event': 'unsubscribe', 'chanId': self.chan_id}
|
|
await self.socket.send(json.dumps(payload))
|
|
|
|
async def subscribe(self):
|
|
"""
|
|
Send a subscription request to the bitfinex socket
|
|
"""
|
|
await self.socket.send(json.dumps(self._get_send_payload()))
|
|
|
|
def confirm_unsubscribe(self):
|
|
"""
|
|
Update the subscription to unsubscribed state
|
|
"""
|
|
self.is_subscribed_bool = False
|
|
|
|
def is_subscribed(self):
|
|
"""
|
|
Check if the subscription is currently subscribed
|
|
|
|
@return bool: True if subscribed else False
|
|
"""
|
|
return self.is_subscribed_bool
|
|
|
|
def _generate_payload(self, **kwargs):
|
|
payload = {'event': 'subscribe',
|
|
'channel': self.channel_name, 'symbol': self.symbol}
|
|
if self.timeframe or self.key:
|
|
payload['key'] = self.key
|
|
payload.update(**kwargs)
|
|
return payload
|
|
|
|
def _get_send_payload(self):
|
|
return self.send_payload
|