Skip to main content

A Lightweight Python Package for Low-Latency and Cross-Exchange Trading.

Project description

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, a simplified version of the 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 synchronous and asynchronous clients across multiple major exchanges, designed for speed, modularity, and ease of use.

Scope note: dcex focuses on market data, account queries, and trading/order APIs. External withdrawal creation endpoints are not currently wrapped, and options support is limited to exchange-specific APIs rather than the unified Product Table Manager.

Python License PyPI

Installation

pip install dcex

or use uv to manage the project:

uv add dcex

Quick Start

Synchronous Usage

import dcex

client = dcex.binance()

klines = client.get_klines(product_symbol="BTC-USDT-SWAP", interval="1m")
print(klines)

Asynchronous Usage

import os
import asyncio
import dcex.async_support as dcex
from dotenv import load_dotenv

load_dotenv()

BINANCE_API_KEY = os.getenv("BINANCE_API_KEY")
BINANCE_API_SECRET = os.getenv("BINANCE_API_SECRET")

async def main():
    client = await dcex.binance(
        api_key=BINANCE_API_KEY,
        api_secret=BINANCE_API_SECRET
    )

    try:
        result = await client.get_income_history()
        print(result)

    finally:
        await client.close()

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

Supported Exchanges

Exchange Sync Support Async Support
Binance Yes Yes
Bybit Yes Yes
OKX Yes Yes
BitMart Yes Yes
BitMEX Yes Yes
Gate.io Yes Yes
Hyperliquid Yes Yes
BingX Yes Yes
KuCoin Yes Yes

Key Features

  • Product Table Manager for unifying trading instruments across exchanges
  • Sync and async API clients with consistent interfaces where available
  • Low-overhead HTTP clients for market data, account queries, and trading workflows
  • Opt-in live test suites for public, private, stateful, and generated-report endpoints

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 actually uses
product_type The normalized product type used by dcex, e.g. spot, swap, futures
exchange_type The exchange-specific product type, e.g. spot, linear, inverse, perpetual, delivery
base_currency The base currency, e.g. BTC
quote_currency The quote currency, 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
size_per_contract The size per contract. Sometimes 1 contract is not the same as 1 unit in exchanges like OKX.

Options are not currently included in the unified PTM output. Some exchange-specific clients expose option-related parameters or market endpoints, but options are not normalized across exchanges.

How to use Product Table Manager?

In most cases, dcex handles product-symbol mapping internally. If you have a specific use case, you can use ptm to get the information you need.

from dcex.utils.common import Common
from dcex.product_table.manager import ProductTableManager

ptm = ProductTableManager.get_instance(Common.BINANCE)

product_symbol = ptm.get_product_symbol(
    exchange=Common.BINANCE,
    exchange_symbol="BTCUSDT",
    product_type="swap",
)

print(product_symbol)

Contributing

We welcome contributions. Please see our Contributing Guide for details.

Testing

The default test suite is offline and does not require exchange API keys or network access:

uv run pytest

Public live exchange tests are opt-in. They use network access but do not require API keys:

uv run pytest -m "live and not private"

Private live tests require the relevant exchange API key environment variables. Use not stateful and not generated for the normal per-exchange key rotation workflow:

uv run pytest tests/sync_support/binance tests/async_support/binance -m "live and private and not stateful and not generated"

Stateful tests can change exchange or account settings, such as leverage or position mode. Run them only when that is intentional:

uv run pytest tests/sync_support/okx tests/async_support/okx -m "live and private and stateful"

Generated-report tests request server-side report generation or downloadable files, such as OKX monthly statements. Run them separately because they can consume low-frequency report quotas:

uv run pytest tests/sync_support/okx tests/async_support/okx -m "live and private and generated"

Examples

Examples are under examples/sync and examples/async. They are concise read-only usage examples:

  • *_public.py examples do not require API keys.
  • *_private_readonly.py examples require credentials but avoid order placement, cancellations, external withdrawals, transfers, leverage changes, and account-mode changes.
  • Endpoint validation belongs in tests, not in examples.

License

This project is licensed under the MIT License.

Support

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.

Project details


Download files

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

Source Distribution

dcex-0.14.0.tar.gz (203.7 kB view details)

Uploaded Source

Built Distribution

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

dcex-0.14.0-py3-none-any.whl (281.5 kB view details)

Uploaded Python 3

File details

Details for the file dcex-0.14.0.tar.gz.

File metadata

  • Download URL: dcex-0.14.0.tar.gz
  • Upload date:
  • Size: 203.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dcex-0.14.0.tar.gz
Algorithm Hash digest
SHA256 b36712a97dd292c6a74de08250f351c4b6fbf2b0f18f5e71698dbc093b162801
MD5 b54121f9a07445742fed1e5aa67e4e88
BLAKE2b-256 3424fb485e02f588bff387730ce3889c52768116465ed140e527bb2e43f5f3ec

See more details on using hashes here.

File details

Details for the file dcex-0.14.0-py3-none-any.whl.

File metadata

  • Download URL: dcex-0.14.0-py3-none-any.whl
  • Upload date:
  • Size: 281.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for dcex-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a84327e3d7b210bfd9fcb331064ad938b2fbe61cb550c2dcc03d44323bc9acf6
MD5 7a72afc21cde3773da75be8e95f1def6
BLAKE2b-256 948f12db28ce445d0ab0f99382c934c2a6ea56ffb179a68c4ece5658a2a16270

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