unicex 0.13.17__py3-none-any.whl → 0.16.5__py3-none-any.whl

unicex/bingx/uni_client.py

@@ -0,0 +1,191 @@
+__all__ = ["UniClient"]
+
+
+from typing import overload
+
+from unicex._abc import IUniClient
+from unicex.enums import Timeframe
+from unicex.types import KlineDict, OpenInterestDict, OpenInterestItem, TickerDailyDict
+
+from .adapter import Adapter
+from .client import Client
+
+
+class UniClient(IUniClient[Client]):
+    """Унифицированный клиент для работы с BingX API."""
+
+    @property
+    def _client_cls(self) -> type[Client]:
+        """Возвращает класс клиента для BingX.
+
+        Возвращает:
+            type[Client]: Класс клиента для BingX.
+        """
+        return Client
+
+    async def tickers(self, only_usdt: bool = True) -> list[str]:
+        """Возвращает список тикеров.
+
+        Параметры:
+            only_usdt (bool): Если True, возвращает только тикеры в паре к USDT.
+
+        Возвращает:
+            list[str]: Список тикеров.
+        """
+        raw_data = await self._client.symbols()
+        return Adapter.tickers(raw_data, only_usdt)
+
+    async def futures_tickers(self, only_usdt: bool = True) -> list[str]:
+        """Возвращает список тикеров.
+
+        Параметры:
+            only_usdt (bool): Если True, возвращает только тикеры в паре к USDT.
+
+        Возвращает:
+            list[str]: Список тикеров.
+        """
+        raw_data = await self._client.futures_contracts()
+        return Adapter.tickers(raw_data, only_usdt)
+
+    async def last_price(self) -> dict[str, float]:
+        """Возвращает последнюю цену для каждого тикера.
+
+        Возвращает:
+            dict[str, float]: Словарь с последними ценами для каждого тикера.
+        """
+        raw_data = await self._client.ticker_24hr()
+        return Adapter.last_price(raw_data)
+
+    async def futures_last_price(self) -> dict[str, float]:
+        """Возвращает последнюю цену для каждого тикера.
+
+        Возвращает:
+            dict[str, float]: Словарь с последними ценами для каждого тикера.
+        """
+        raw_data = await self._client.futures_ticker_price()
+        return Adapter.last_price(raw_data)
+
+    async def ticker_24hr(self) -> TickerDailyDict:
+        """Возвращает статистику за последние 24 часа для каждого тикера.
+
+        Возвращает:
+            TickerDailyDict: Словарь с статистикой за последние 24 часа для каждого тикера.
+        """
+        raw_data = await self._client.ticker_24hr()
+        return Adapter.ticker_24hr(raw_data)
+
+    async def futures_ticker_24hr(self) -> TickerDailyDict:
+        """Возвращает статистику за последние 24 часа для каждого тикера.
+
+        Возвращает:
+            TickerDailyDict: Словарь с статистикой за последние 24 часа для каждого тикера.
+        """
+        raw_data = await self._client.futures_ticker_24hr()
+        return Adapter.ticker_24hr(raw_data)
+
+    async def klines(
+        self,
+        symbol: str,
+        interval: Timeframe | str,
+        limit: int | None = None,
+        start_time: int | None = None,
+        end_time: int | None = None,
+    ) -> list[KlineDict]:
+        """Возвращает список свечей для тикера.
+
+        Параметры:
+            symbol (str): Название тикера.
+            limit (int | None): Количество свечей.
+            interval (Timeframe | str): Таймфрейм свечей.
+            start_time (int | None): Время начала периода в миллисекундах.
+            end_time (int | None): Время окончания периода в миллисекундах.
+
+        Возвращает:
+            list[KlineDict]: Список свечей для тикера.
+        """
+        interval = interval.value if isinstance(interval, Timeframe) else interval
+        raw_data = await self._client.klines(
+            symbol=symbol,
+            interval=interval,
+            limit=limit,
+            start_time=start_time,
+            end_time=end_time,
+        )
+        return Adapter.klines(raw_data)
+
+    async def futures_klines(
+        self,
+        symbol: str,
+        interval: Timeframe | str,
+        limit: int | None = None,
+        start_time: int | None = None,
+        end_time: int | None = None,
+    ) -> list[KlineDict]:
+        """Возвращает список свечей для тикера.
+
+        Параметры:
+            symbol (str): Название тикера.
+            limit (int | None): Количество свечей.
+            interval (Timeframe | str): Таймфрейм свечей.
+            start_time (int | None): Время начала периода в миллисекундах.
+            end_time (int | None): Время окончания периода в миллисекундах.
+
+        Возвращает:
+            list[KlineDict]: Список свечей для тикера.
+        """
+        interval = interval.value if isinstance(interval, Timeframe) else interval
+        raw_data = await self._client.futures_klines(
+            symbol=symbol,
+            interval=interval,
+            limit=limit,
+            start_time=start_time,
+            end_time=end_time,
+        )
+        return Adapter.klines(raw_data)
+
+    @overload
+    async def funding_rate(self, symbol: str) -> float: ...
+
+    @overload
+    async def funding_rate(self, symbol: None) -> dict[str, float]: ...
+
+    @overload
+    async def funding_rate(self) -> dict[str, float]: ...
+
+    async def funding_rate(self, symbol: str | None = None) -> dict[str, float] | float:
+        """Возвращает ставку финансирования для тикера или всех тикеров, если тикер не указан.
+
+        Параметры:
+            symbol (`str | None`): Название тикера (Опционально).
+
+        Возвращает:
+            dict[str, float] | float: Ставка финансирования для тикера или словарь со ставками.
+        """
+        raw_data = await self._client.futures_mark_price(symbol=symbol)
+        adapted_data = Adapter.funding_rate(raw_data)
+        return adapted_data[symbol] if symbol else adapted_data
+
+    @overload
+    async def open_interest(self, symbol: str) -> OpenInterestItem: ...
+
+    @overload
+    async def open_interest(self, symbol: None) -> OpenInterestDict: ...
+
+    @overload
+    async def open_interest(self) -> OpenInterestDict: ...
+
+    async def open_interest(self, symbol: str | None = None) -> OpenInterestItem | OpenInterestDict:
+        """Возвращает объем открытого интереса для тикера или всех тикеров, если тикер не указан.
+
+        Параметры:
+            symbol (`str | None`): Название тикера. (Опционально, но обязателен для следующих бирж: BINANCE).
+
+        Возвращает:
+            `OpenInterestItem | OpenInterestDict`: Если тикер передан - словарь со временем и объемом
+                открытого интереса в монетах. Если нет передан - то словарь, в котором ключ - тикер,
+                а значение - словарь с временем и объемом открытого интереса в монетах.
+        """
+        if not symbol:
+            raise ValueError("Symbol is required for bingx open interest")
+        raw_data = await self._client.open_interest(symbol=symbol)
+        return Adapter.open_interest(raw_data)

unicex/bingx/uni_websocket_manager.py

@@ -0,0 +1,283 @@
+__all__ = ["IUniWebsocketManager"]
+
+from collections.abc import Awaitable, Callable, Sequence
+from typing import Any, overload
+
+from unicex._abc import IUniWebsocketManager
+from unicex._base import Websocket
+from unicex.enums import Timeframe
+from unicex.types import LoggerLike
+
+from .adapter import Adapter
+from .client import Client
+from .uni_client import UniClient
+from .websocket_manager import WebsocketManager
+
+type CallbackType = Callable[[Any], Awaitable[None]]
+
+
+class UniWebsocketManager(IUniWebsocketManager):
+    """Реализация менеджера асинхронных унифицированных вебсокетов."""
+
+    def __init__(
+        self,
+        client: Client | UniClient | None = None,
+        logger: LoggerLike | None = None,
+        **ws_kwargs: Any,
+    ) -> None:
+        """Инициализирует унифицированный менеджер вебсокетов.
+
+        Параметры:
+            client (`Client | UniClient | None`): Клиент BingX или унифицированный клиент. Нужен для подключения к приватным топикам.
+            logger (`LoggerLike | None`): Логгер для записи логов.
+            ws_kwargs (`dict[str, Any]`): Дополнительные параметры инициализации, которые будут переданы WebsocketManager/Websocket.
+        """
+        super().__init__(client=client, logger=logger)
+        self._websocket_manager = WebsocketManager(self._client, **ws_kwargs)  # type: ignore
+        self._adapter = Adapter()
+
+    @overload
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим свечей (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            timeframe (`Timeframe`): Временной интервал свечей.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета для управления соединением.
+        """
+        raise NotImplementedError()
+
+    @overload
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим свечей (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            timeframe (`Timeframe`): Временной интервал свечей.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        raise NotImplementedError()
+
+    @overload
+    def trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def trades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим сделок (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        return self._websocket_manager.trade(
+            callback=self._make_wrapper(self._adapter.trades_message, callback),
+            symbol=symbol,
+            symbols=symbols,
+            market_type="SPOT",
+        )
+
+    @overload
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим агрегированных сделок (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        return self.trades(callback, symbol=symbol, symbols=symbols)  # type: ignore
+
+    @overload
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим сделок (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        return self._websocket_manager.trade(
+            callback=self._make_wrapper(self._adapter.futures_trades_message, callback),
+            symbol=symbol,
+            symbols=symbols,
+            market_type="FUTURES",
+        )
+
+    @overload
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим агрегированных сделок (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        return self.futures_trades(callback, symbol=symbol, symbols=symbols)  # type: ignore

unicex/bingx/user_websocket.py

@@ -0,0 +1,7 @@
+__all__ = ["UserWebsocket"]
+
+
+class UserWebsocket:
+    """Пользовательский вебсокет BingX."""
+
+    pass

unicex/bingx/websocket_manager.py

@@ -0,0 +1,118 @@
+__all__ = ["WebsocketManager"]
+
+
+import gzip
+import json
+from collections.abc import Awaitable, Callable, Sequence
+from typing import Any, Literal
+
+import orjson
+
+from unicex._base import Websocket
+from unicex.utils import validate_single_symbol_args
+
+from .client import Client
+
+type CallbackType = Callable[[Any], Awaitable[None]]
+
+
+class WebsocketManager:
+    """Менеджер асинхронных вебсокетов для BingX."""
+
+    _BASE_SPOT_URL: str = "wss://open-api-ws.bingx.com/market"
+    """Базовый URL для вебсокета на спот."""
+
+    _BASE_FUTURES_URL: str = "wss://open-api-swap.bingx.com/swap-market"
+    """Базовый URL для вебсокета на фьючерсы."""
+
+    class _BingXGzipDecoder:
+        """Класс для декодирования gzip-сообщений WebSocket от BingX."""
+
+        def decode(self, message: Any) -> dict | Literal["ping"]:
+            if isinstance(message, bytes):
+                try:
+                    message = gzip.decompress(message).decode("utf-8")
+                except OSError:
+                    message = message.decode("utf-8")
+
+            if message == "Ping":
+                return "ping"
+
+            return orjson.loads(message)
+
+    def __init__(self, client: Client | None = None, **ws_kwargs: Any) -> None:
+        """Инициализирует менеджер вебсокетов для BingX.
+
+        Параметры:
+            client (`Client | None`): Клиент для выполнения запросов. Нужен, чтобы открыть приватные вебсокеты.
+            ws_kwargs (`dict[str, Any]`): Дополнительные аргументы, которые прокидываются в `Websocket`.
+        """
+        self.client = client
+        self._ws_kwargs = ws_kwargs
+
+    def _get_url(self, market_type: Literal["SPOT", "FUTURES"]) -> str:
+        """Возвращает URL для указанного типа рынка."""
+        if market_type == "SPOT":
+            return self._BASE_SPOT_URL
+        if market_type == "FUTURES":
+            return self._BASE_FUTURES_URL
+        raise ValueError(f"Unsupported market type: {market_type}")
+
+    def _generate_subscription_messages(
+        self,
+        data_types: Sequence[str],
+        req_id: str | None = None,
+    ) -> list[str]:
+        """Сформировать сообщения для подписки на вебсокет.
+
+        Параметры:
+            data_types (`Sequence[str]`): Список топиков для подписки.
+            req_id (`str | None`): Опциональный идентификатор запроса.
+
+        Возвращает:
+            `list[str]`: Список JSON-строк с сообщениями для подписки.
+        """
+        messages = []
+        for data_type in data_types:
+            message = {"reqType": "sub", "dataType": data_type}
+            if req_id:
+                message["id"] = req_id
+            messages.append(json.dumps(message))
+        return messages
+
+    def trade(
+        self,
+        callback: CallbackType,
+        market_type: Literal["SPOT", "FUTURES"],
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+        req_id: str | None = None,
+    ) -> Websocket:
+        """Создает вебсокет для получения сделок.
+
+        https://bingx-api.github.io/docs-v3/#/en/Swap/Market%20Data/Subscribe%20to%20Tick-by-Tick%20Trades
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            market_type (`Literal["SPOT", "FUTURES"]`): Тип рынка.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+            req_id (`str | None`): Опциональный идентификатор запроса.
+
+        Возвращает:
+            `Websocket`: Объект для управления вебсокет соединением.
+        """
+        validate_single_symbol_args(symbol, symbols)
+
+        tickers = [symbol] if symbol else symbols
+        data_types = [f"{ticker.upper()}@trade" for ticker in tickers]  # type: ignore[arg-type]
+
+        subscription_messages = self._generate_subscription_messages(data_types, req_id)
+        return Websocket(
+            callback=callback,
+            url=self._get_url(market_type),
+            subscription_messages=subscription_messages,
+            decoder=self._BingXGzipDecoder,
+            pong_message="Pong",
+            **self._ws_kwargs,
+        )

unicex/bitget/adapter.py

@@ -1,7 +1,6 @@
 from typing import Any
 
 from unicex.types import (
-    AggTradeDict,
     KlineDict,
     OpenInterestDict,
     OpenInterestItem,
@@ -155,7 +154,7 @@ class Adapter:
         symbol = raw_msg["arg"]["instId"]
 
         return [
-            AggTradeDict(
+            TradeDict(
                 t=int(trade["ts"]),
                 s=symbol,
                 S=trade["side"].upper(),
@@ -183,6 +182,7 @@ class Adapter:
             i["symbol"]: OpenInterestItem(
                 t=int(i["ts"]),
                 v=float(i["holdingAmount"]),
+                u="coins",
             )
             for i in raw_data["data"]
         }