Client

Defined in dccd

class Client(config_path=None)

Bases: object

Async context manager facade for dccd v3.

Parameters:

config_pathstr or None

Path to config.yml. Resolved via XDG fallback when None.

Examples

>>> import asyncio
>>> async def example():
...     from dccd import Client
...     async with Client() as c:
...         pass

async backfill(exchange, symbol, data_type='ohlc', span=None, start='last')

Backfill one dataset.

Parameters:

exchangestr

symbolstr

E.g. 'BTC/USDT' or 'BTC-USD'.

data_typestr

'ohlc', 'trades', or 'orderbook'.

spanint or None

Required for OHLC.

startstr

'last', 'origin', or ISO date.

inventory()

List stored datasets.

read(exchange, symbol, data_type='ohlc', span=None, start_ns=None, end_ns=None)

Read stored data for a dataset as a Polars DataFrame.

async stream(exchange, symbol, data_type='trades', span=None, depth=None, snapshot_interval=None, stop_event=None)

Stream live data until stop_event is set.

Parameters mirror backfill; stop_event is an asyncio.Event used to stop the stream cleanly.