Skip to main content

Unified Crypto Exchange API

Project description

Unified Crypto Exchange API

unicex — асинхронная библиотека для работы с криптовалютными биржами, реализующая унифицированный интерфейс поверх «сырых» REST и WebSocket API разных бирж.

✅ Статус реализации

Exchange Client Auth WS Manager User WS Uni Client Uni WS Manager ExchangeInfo
Binance
Bitget
Bybit
Gateio
Hyperliquid
Mexc
Okx

📖 Описание колонок

  • Client – Обертки над HTTP методами следующих разделов: market, order, position, account.
  • Auth – Поддержка авторизации и приватных эндпоинтов.
  • WS Manager – Обертки над вебсокетами биржи.
  • User WS – Поддержка пользовательских вебсокетов.
  • UniClient –Унифированный клиент.
  • UniWebsocketManager – Унифированный менеджер вебсокетов.
  • ExchangeInfo - Информация о бирже для округления цен и объемов

🚀 Быстрый старт

  • Установка: pip install unicex или из исходников: pip install -e .
  • Библиотека полностью асинхронная. Примеры импорта:
    • Сырые клиенты: from unicex.binance import Client
    • Унифицированные клиенты: from unicex.binance import UniClient
    • Вебсокет менеджеры: from unicex.binance import WebsocketManager, UniWebsocketManager

Пример: Получение рыночных данных через API

import asyncio

from unicex import Exchange, Timeframe, get_uni_client

# Выбираем биржу, с которой хотим работать.
# Поддерживаются: Binance, Bybit, Bitget, Mexc, Gateio, Hyperliquid и другие.
exchange = Exchange.BYBIT


async def main() -> None:
    """Пример простого использования унифицированного клиента unicex."""
    # 1️⃣ Создаём клиент для выбранной биржи
    client = await get_uni_client(exchange).create()

    # 2️⃣ Получаем открытый интерес по всем контрактам
    open_interest = await client.open_interest()
    print(open_interest)

    # Пример вывода:
    # {
    #   "BTCUSDT": {"t": 1759669833728, "v": 61099320.0},
    #   "ETHUSDT": {"t": 1759669833728, "v": 16302340.0},
    #   "SOLUSDT": {"t": 1759669833728, "v": 3427780.0},
    #   ...
    # }

    # 3️⃣ Можно точно так же получать другие данные в едином формате:
    await client.tickers()  # список всех тикеров
    await client.futures_tickers()  # тикеры фьючерсов
    await client.ticker_24hr()  # статистика за 24 часа (spot)
    await client.futures_ticker_24hr()  # статистика за 24 часа (futures)
    await client.klines("BTCUSDT", Timeframe.MIN_5)  # свечи спота
    await client.futures_klines("BTCUSDT", Timeframe.HOUR_1)  # свечи фьючерсов
    await client.funding_rate()  # ставка финансирования


if __name__ == "__main__":
    asyncio.run(main())

Пример: Получение данных в реальном времени через Websocket API

import asyncio
from unicex import Exchange, TradeDict, get_uni_websocket_manager
from unicex.enums import Timeframe

# Выбираем биржу, с которой хотим работать.
# Поддерживаются: Binance, Bybit, Bitget, Mexc, Gateio, Hyperliquid и другие.
exchange = Exchange.BITGET


async def main() -> None:
    """Пример простого использования унифицированного менеджера Websocket от UniCEX."""

    # 1️⃣ Создаём WebSocket-менеджер для выбранной биржи
    ws_manager = get_uni_websocket_manager(exchange)()

    # 2️⃣ Подключаемся к потоку сделок (aggTrades)
    aggtrades_ws = ws_manager.aggtrades(
        callback=callback,
        symbols=["BTCUSDT", "ETHUSDT"],
    )

    # Запускаем получение данных
    await aggtrades_ws.start()

    # 3️⃣ Примеры других типов потоков:
    futures_aggtrades_ws = ws_manager.futures_aggtrades(
        callback=callback,
        symbols=["BTCUSDT", "ETHUSDT"],
    )

    klines_ws = ws_manager.klines(
        callback=callback,
        symbols=["BTCUSDT", "ETHUSDT"],
        timeframe=Timeframe.MIN_5,
    )

    futures_klines_ws = ws_manager.futures_klines(
        callback=callback,
        symbols=["BTCUSDT", "ETHUSDT"],
        timeframe=Timeframe.MIN_1,
    )

    # 💡 Также у каждой биржи есть свой WebsocketManager:
    #     unicex.<exchange>.websocket_manager.WebsocketManager
    # В нём реализованы остальные методы для работы с WS API.


async def callback(trade: TradeDict) -> None:
    """Обработка входящих данных из Websocket."""
    print(trade)
    # Пример вывода:
    # {'t': 1759670527594, 's': 'BTCUSDT', 'S': 'BUY',  'p': 123238.87, 'v': 0.05}
    # {'t': 1759670527594, 's': 'BTCUSDT', 'S': 'BUY',  'p': 123238.87, 'v': 0.04}
    # {'t': 1759670346828, 's': 'ETHUSDT', 'S': 'SELL', 'p': 4535.0,    'v': 0.0044}
    # {'t': 1759670347087, 's': 'ETHUSDT', 'S': 'BUY',  'p': 4534.91,   'v': 0.2712}


if __name__ == "__main__":
    asyncio.run(main())

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unicex-0.11.0.tar.gz (145.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unicex-0.11.0-py3-none-any.whl (185.6 kB view details)

Uploaded Python 3

File details

Details for the file unicex-0.11.0.tar.gz.

File metadata

  • Download URL: unicex-0.11.0.tar.gz
  • Upload date:
  • Size: 145.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for unicex-0.11.0.tar.gz
Algorithm Hash digest
SHA256 db883233ed87857a1a07d28357c7ced797deaecc164e9f751069dfeb5c49567c
MD5 bca6908127abd111fb0ada22ccd23479
BLAKE2b-256 c120dc76c345aad21d4b7cfd761835bd57be4c79f31b16893d462ca5bf378760

See more details on using hashes here.

File details

Details for the file unicex-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: unicex-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 185.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for unicex-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ef098267e15efe9c3c5403bec98149c7d2f45785ac2c7422e36d6781feb87d4
MD5 f65461cb7bb5a5ce2ce78d74347883bf
BLAKE2b-256 a657585a89576a6f11451bda01750f7cd364ad809cdfeaa35d3cd650c6dd2a8f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page