dcex 0.3.0__tar.gz

dcex-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sam Hong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dcex-0.3.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: dcex
+Version: 0.3.0
+Summary: A Lightweight Python Package for Low-Latency and Cross-Exchange Trading.
+Author: Sam Hong
+License: MIT
+Project-URL: Repository, https://github.com/pg56714/dcex
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: polars>=1.34.0
+Requires-Dist: requests>=2.32.5
+Requires-Dist: msgspec>=0.19.0
+Dynamic: license-file
+
+# dcex - dex & cex trading library
+
+**Important**: No default broker tags are set. You may manually specify a broker tag within function arguments if needed.
+
+> Forked from [krex](https://github.com/kairosresearchio/krex), a simplified version of the [ccxt](https://github.com/ccxt/ccxt) Python library.
+
+> Originally created and maintained by the same contributor, this fork continues active development, building upon the original foundation with enhanced design, unified DEX + CEX support, and fixes for previously unresolved issues.
+
+A high-performance and lightweight Python library for interacting with cryptocurrency exchanges. dcex offers full synchronous and asynchronous support across major exchanges, designed for speed, modularity, and ease of use.
+
+[![Python Version](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://python.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://badge.fury.io/py/dcex.svg)](https://badge.fury.io/py/dcex)
+
+## 📦 Installation
+
+```bash
+pip install dcex
+```
+
+or use `uv` to manage the project:
+
+```bash
+uv add dcex
+```
+
+## 🚀 Quick Start
+
+### Synchronous Usage
+
+```python
+import dcex
+import os
+
+# Initialize client for any supported exchange
+client = dcex.binance(
+    api_key="your_api_key",
+    api_secret="your_api_secret"
+)
+
+# Get market data
+klines = client.get_klines(product_symbol="BTCUSDT", interval="1h")
+print(klines)
+```
+
+### Asynchronous Usage
+
+```python
+import asyncio
+import dcex.async_support as dcex
+import os
+
+async def main():
+    # Initialize async client
+    client = await dcex.binance(
+        api_key="your_api_key",
+        api_secret="your_api_secret"
+    )
+
+    try:
+        # Get market data
+        klines = await client.get_klines(product_symbol="BTCUSDT", interval="1h")
+        print(klines)
+
+    finally:
+        await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## 📚 Supported Exchanges
+
+| Exchange        | Sync Support | Async Support |
+| --------------- | ------------ | ------------- |
+| **Binance**     | Testing      | Testing       |
+| **Bybit**       | Testing      | Testing       |
+| **OKX**         | ✅           | ✅            |
+| **BitMart**     | Testing      | Testing       |
+| **Gate.io**     | Testing      | Testing       |
+| **Hyperliquid** | Testing      | Testing       |
+| **BitMEX**      | Testing      | Testing       |
+| **BingX**       | Developing   | Developing    |
+| **AscendEX**    | Developing   | Developing    |
+| **KuCoin**      | Developing   | Developing    |
+
+## 🔍 Key Features
+
+- 📘 Product Table Manager for unifying trading instruments in different exchanges
+- 🔁 Sync & Async API clients with identical interfaces
+- ⚡ Optimized for low-latency, high-frequency trading
+
+## What is Product Table Manager(ptm)?
+
+Ptm is a utility that standardizes and unifies trading instrument metadata across different exchanges, making cross-exchange strategy development easier.
+
+It is a table that contains the following columns:
+
+| Column            | Description                                                                                                                                                                                                                |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| exchange          | The exchange name                                                                                                                                                                                                          |
+| product_symbol    | The symbol we use to identify the product, it will be the same in different exchanges. For example, `BTC-USDT-SWAP` is the same product in Binance and Bybit, which named `BTCUSDT` in Binance and `BTC-USDT-SWAP` in OKX. |
+| exchange_symbol   | The symbol that the exchange will actually used                                                                                                                                                                            |
+| product_type      | The type we will use, e.g. `spot`, `inverse`, `swap`, `futures`                                                                                                                                                            |
+| exchange_type     | The type the exchange will actually used, e.g. `linear`, `INVERSE`, `perp`... different exchanges have different types, pretty annoying...                                                                                 |
+| base_symbol       | The base symbol, e.g. `BTC`                                                                                                                                                                                                |
+| quote_symbol      | The quote symbol, e.g. `USDT`                                                                                                                                                                                              |
+| price_precision   | The price precision, e.g. `0.000001`                                                                                                                                                                                       |
+| size_precision    | The size precision, e.g. `0.000001`                                                                                                                                                                                        |
+| min_size          | The minimum size, e.g. `0.000001`                                                                                                                                                                                          |
+| min_notional      | The minimum notional, e.g. `0.000001`                                                                                                                                                                                      |
+| multiplier        | The multiplier of the product, such symbol like `1000BONKUSDT` in Bybit will need to be multiplied by 1000 to get the actual size, if you are trading across spot and swap, you will need this                             |
+| size_per_contract | The size per contract. Sometimes 1 contract is not the same as 1 unit in exchanges like OKX.                                                                                                                               |
+
+## How to use Product Table Manager?
+
+In most cases, we have handled the case, but if you have any specific use cases, you can use the `ptm` to get the information you want.
+
+```python
+import dcex
+
+bn = dcex.binance()
+
+product_symbol = bn.ptm.get_product_symbol(
+    exchange="binance",
+    exchange_symbol="BTCUSDT",
+    product_type="swap",
+)
+
+print(product_symbol)
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details.
+
+### Contributors
+
+<a href="https://github.com/pg56714/dcex/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=pg56714/dcex" />
+</a>
+
+## 📄 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## 🆘 Support
+
+- **Issues**: Report bugs and request features on [GitHub Issues](https://github.com/pg56714/dcex/issues).
+- **Discussions**: Discuss ideas and share your thoughts on [GitHub Discussions](https://github.com/pg56714/dcex/discussions).
+
+## 📜 Disclaimer
+
+Cryptocurrency trading involves significant risk. This library is provided as-is without any warranty. Users are responsible for their own trading decisions and risk management.

dcex-0.3.0/README.md

@@ -0,0 +1,154 @@
+# dcex - dex & cex trading library
+
+**Important**: No default broker tags are set. You may manually specify a broker tag within function arguments if needed.
+
+> Forked from [krex](https://github.com/kairosresearchio/krex), a simplified version of the [ccxt](https://github.com/ccxt/ccxt) Python library.
+
+> Originally created and maintained by the same contributor, this fork continues active development, building upon the original foundation with enhanced design, unified DEX + CEX support, and fixes for previously unresolved issues.
+
+A high-performance and lightweight Python library for interacting with cryptocurrency exchanges. dcex offers full synchronous and asynchronous support across major exchanges, designed for speed, modularity, and ease of use.
+
+[![Python Version](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://python.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://badge.fury.io/py/dcex.svg)](https://badge.fury.io/py/dcex)
+
+## 📦 Installation
+
+```bash
+pip install dcex
+```
+
+or use `uv` to manage the project:
+
+```bash
+uv add dcex
+```
+
+## 🚀 Quick Start
+
+### Synchronous Usage
+
+```python
+import dcex
+import os
+
+# Initialize client for any supported exchange
+client = dcex.binance(
+    api_key="your_api_key",
+    api_secret="your_api_secret"
+)
+
+# Get market data
+klines = client.get_klines(product_symbol="BTCUSDT", interval="1h")
+print(klines)
+```
+
+### Asynchronous Usage
+
+```python
+import asyncio
+import dcex.async_support as dcex
+import os
+
+async def main():
+    # Initialize async client
+    client = await dcex.binance(
+        api_key="your_api_key",
+        api_secret="your_api_secret"
+    )
+
+    try:
+        # Get market data
+        klines = await client.get_klines(product_symbol="BTCUSDT", interval="1h")
+        print(klines)
+
+    finally:
+        await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## 📚 Supported Exchanges
+
+| Exchange        | Sync Support | Async Support |
+| --------------- | ------------ | ------------- |
+| **Binance**     | Testing      | Testing       |
+| **Bybit**       | Testing      | Testing       |
+| **OKX**         | ✅           | ✅            |
+| **BitMart**     | Testing      | Testing       |
+| **Gate.io**     | Testing      | Testing       |
+| **Hyperliquid** | Testing      | Testing       |
+| **BitMEX**      | Testing      | Testing       |
+| **BingX**       | Developing   | Developing    |
+| **AscendEX**    | Developing   | Developing    |
+| **KuCoin**      | Developing   | Developing    |
+
+## 🔍 Key Features
+
+- 📘 Product Table Manager for unifying trading instruments in different exchanges
+- 🔁 Sync & Async API clients with identical interfaces
+- ⚡ Optimized for low-latency, high-frequency trading
+
+## What is Product Table Manager(ptm)?
+
+Ptm is a utility that standardizes and unifies trading instrument metadata across different exchanges, making cross-exchange strategy development easier.
+
+It is a table that contains the following columns:
+
+| Column            | Description                                                                                                                                                                                                                |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| exchange          | The exchange name                                                                                                                                                                                                          |
+| product_symbol    | The symbol we use to identify the product, it will be the same in different exchanges. For example, `BTC-USDT-SWAP` is the same product in Binance and Bybit, which named `BTCUSDT` in Binance and `BTC-USDT-SWAP` in OKX. |
+| exchange_symbol   | The symbol that the exchange will actually used                                                                                                                                                                            |
+| product_type      | The type we will use, e.g. `spot`, `inverse`, `swap`, `futures`                                                                                                                                                            |
+| exchange_type     | The type the exchange will actually used, e.g. `linear`, `INVERSE`, `perp`... different exchanges have different types, pretty annoying...                                                                                 |
+| base_symbol       | The base symbol, e.g. `BTC`                                                                                                                                                                                                |
+| quote_symbol      | The quote symbol, e.g. `USDT`                                                                                                                                                                                              |
+| price_precision   | The price precision, e.g. `0.000001`                                                                                                                                                                                       |
+| size_precision    | The size precision, e.g. `0.000001`                                                                                                                                                                                        |
+| min_size          | The minimum size, e.g. `0.000001`                                                                                                                                                                                          |
+| min_notional      | The minimum notional, e.g. `0.000001`                                                                                                                                                                                      |
+| multiplier        | The multiplier of the product, such symbol like `1000BONKUSDT` in Bybit will need to be multiplied by 1000 to get the actual size, if you are trading across spot and swap, you will need this                             |
+| size_per_contract | The size per contract. Sometimes 1 contract is not the same as 1 unit in exchanges like OKX.                                                                                                                               |
+
+## How to use Product Table Manager?
+
+In most cases, we have handled the case, but if you have any specific use cases, you can use the `ptm` to get the information you want.
+
+```python
+import dcex
+
+bn = dcex.binance()
+
+product_symbol = bn.ptm.get_product_symbol(
+    exchange="binance",
+    exchange_symbol="BTCUSDT",
+    product_type="swap",
+)
+
+print(product_symbol)
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details.
+
+### Contributors
+
+<a href="https://github.com/pg56714/dcex/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=pg56714/dcex" />
+</a>
+
+## 📄 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## 🆘 Support
+
+- **Issues**: Report bugs and request features on [GitHub Issues](https://github.com/pg56714/dcex/issues).
+- **Discussions**: Discuss ideas and share your thoughts on [GitHub Discussions](https://github.com/pg56714/dcex/discussions).
+
+## 📜 Disclaimer
+
+Cryptocurrency trading involves significant risk. This library is provided as-is without any warranty. Users are responsible for their own trading decisions and risk management.

dcex-0.3.0/dcex/__init__.py

@@ -0,0 +1,59 @@
+"""
+dcex - dex & cex trading library.
+
+A comprehensive library for cryptocurrency exchange interactions with both sync and async support.
+Automatically handles Jupyter Notebook compatibility with nest_asyncio.
+"""
+
+from typing import Any
+
+from .binance.client import Client as BinanceClient
+from .bitmart.client import Client as BitmartClient
+from .bitmex.client import Client as BitmexClient
+from .bybit.client import Client as BybitClient
+from .gateio.client import Client as GateioClient
+from .okx.client import Client as OKXClient
+from .utils.jupyter_helper import auto_apply_nest_asyncio
+
+auto_apply_nest_asyncio(verbose=False)
+
+
+# Create callable functions for each exchange (synchronous clients)
+def binance(**kwargs: Any) -> BinanceClient:  # noqa: ANN401
+    """Create a Binance client instance."""
+    return BinanceClient(**kwargs)
+
+
+def bitmart(**kwargs: Any) -> BitmartClient:  # noqa: ANN401
+    """Create a BitMart client instance."""
+    return BitmartClient(**kwargs)
+
+
+def bitmex(**kwargs: Any) -> BitmexClient:  # noqa: ANN401
+    """Create a BitMEX client instance."""
+    return BitmexClient(**kwargs)
+
+
+def bybit(**kwargs: Any) -> BybitClient:  # noqa: ANN401
+    """Create a Bybit client instance."""
+    return BybitClient(**kwargs)
+
+
+def gateio(**kwargs: Any) -> GateioClient:  # noqa: ANN401
+    """Create a Gate.io client instance."""
+    return GateioClient(**kwargs)
+
+
+def okx(**kwargs: Any) -> OKXClient:  # noqa: ANN401
+    """Create an OKX client instance."""
+    return OKXClient(**kwargs)
+
+
+__all__ = [
+    "binance",
+    "bitmart",
+    "bitmex",
+    "bybit",
+    "gateio",
+    "okx",
+]

dcex-0.3.0/dcex/async_support/__init__.py

@@ -0,0 +1,113 @@
+"""
+Async exchange entry points.
+
+This module exposes coroutine factory functions for each supported exchange,
+which return an initialized async client (after awaiting `async_init`).
+"""
+
+# Import exchange client classes and create callable functions
+from typing import Any, cast
+
+from .ascendex.client import Client as AscendexClient
+from .binance.client import Client as BinanceClient
+from .bingx.client import Client as BingXClient
+from .bitmart.client import Client as BitmartClient
+from .bitmex.client import Client as BitmexClient
+from .bybit.client import Client as BybitClient
+from .gateio.client import Client as GateioClient
+from .hyperliquid.client import Client as HyperliquidClient
+from .kucoin.client import Client as KuCoinClient
+from .okx.client import Client as OKXClient
+from .zoomex.client import Client as ZoomexClient
+
+
+async def ascendex(
+    **kwargs: Any,  # noqa: ANN401
+) -> AscendexClient:
+    """Create and initialize an AscendEX client instance."""
+    return cast(AscendexClient, await AscendexClient(**kwargs).async_init())
+
+
+async def binance(
+    **kwargs: Any,  # noqa: ANN401
+) -> BinanceClient:
+    """Create and initialize a Binance client instance."""
+    return cast(BinanceClient, await BinanceClient(**kwargs).async_init())
+
+
+async def bingx(
+    **kwargs: Any,  # noqa: ANN401
+) -> BingXClient:
+    """Create and initialize a BingX client instance."""
+    return cast(BingXClient, await BingXClient(**kwargs).async_init())
+
+
+async def bitmart(
+    **kwargs: Any,  # noqa: ANN401
+) -> BitmartClient:
+    """Create and initialize a BitMart client instance."""
+    return cast(BitmartClient, await BitmartClient(**kwargs).async_init())
+
+
+async def bitmex(
+    **kwargs: Any,  # noqa: ANN401
+) -> BitmexClient:
+    """Create and initialize a BitMEX client instance."""
+    return cast(BitmexClient, await BitmexClient(**kwargs).async_init())
+
+
+async def bybit(
+    **kwargs: Any,  # noqa: ANN401
+) -> BybitClient:
+    """Create and initialize a Bybit client instance."""
+    return cast(BybitClient, await BybitClient(**kwargs).async_init())
+
+
+async def gateio(
+    **kwargs: Any,  # noqa: ANN401
+) -> GateioClient:
+    """Create and initialize a Gate.io client instance."""
+    return cast(GateioClient, await GateioClient(**kwargs).async_init())
+
+
+async def hyperliquid(
+    **kwargs: Any,  # noqa: ANN401
+) -> HyperliquidClient:
+    """Create and initialize a Hyperliquid client instance."""
+    return cast(HyperliquidClient, await HyperliquidClient(**kwargs).async_init())
+
+
+async def kucoin(
+    **kwargs: Any,  # noqa: ANN401
+) -> KuCoinClient:
+    """Create and initialize a KuCoin client instance."""
+    return cast(KuCoinClient, await KuCoinClient(**kwargs).async_init())
+
+
+async def okx(
+    **kwargs: Any,  # noqa: ANN401
+) -> OKXClient:
+    """Create and initialize an OKX client instance."""
+    return cast(OKXClient, await OKXClient(**kwargs).async_init())
+
+
+async def zoomex(
+    **kwargs: Any,  # noqa: ANN401
+) -> ZoomexClient:
+    """Create and initialize a Zoomex client instance."""
+    return cast(ZoomexClient, await ZoomexClient(**kwargs).async_init())
+
+
+__all__ = [
+    "ascendex",
+    "binance",
+    "bingx",
+    "bitmart",
+    "bitmex",
+    "bybit",
+    "gateio",
+    "hyperliquid",
+    "kucoin",
+    "okx",
+    "zoomex",
+]

dcex-0.3.0/dcex/async_support/okx/__init__.py

@@ -0,0 +1,3 @@
+from .client import Client
+
+__all__ = ["Client"]