Skip to content

StreamForge

Backfilling

paulobueno90/streamforge

Backfilling API¶

Auto-generated API documentation for StreamForge backfilling.

BinanceBackfilling¶

BinanceBackfilling ¶

BinanceBackfilling(symbol: str, timeframe: str, from_date: str, to_date: str = 'now', file_path: Optional[str] = None, data_type: str = 'klines', transformer: Optional[Callable[[Dict[str, Any]], Dict[str, Any]]] = None)

run ¶

run()

register_emitter ¶

register_emitter(emitter: DataEmitter, model: Optional[Union[Base, BaseModel]] = None, map_object: Optional[Dict] = None)

set_transformer ¶

set_transformer(transformer_func: Callable[[Dict[str, Any]], Dict[str, Any]], inplace: bool = False)

OkxBackfilling¶

OkxBackfilling ¶

OkxBackfilling(symbol: str, timeframe: str, from_date: str, to_date: str = 'now', file_path: Optional[str] = None, data_type: str = 'klines', transformer: Optional[Callable[[Dict[str, Any]], Dict[str, Any]]] = None)

run ¶

run()

register_emitter ¶

register_emitter(emitter: DataEmitter, model: Optional[Union[Base, BaseModel]] = None, map_object: Optional[Dict] = None)

set_transformer ¶

set_transformer(transformer_func: Callable[[Dict[str, Any]], Dict[str, Any]], inplace: bool = False)

Common Usage¶

Basic Backfill¶

from streamforge import BinanceBackfilling

backfiller = BinanceBackfilling(
    symbol="BTCUSDT",
    timeframe="1h",
    from_date="2024-01-01",
    to_date="2024-12-31"
)

backfiller.run()  # Sync method

With Emitter¶

backfiller = BinanceBackfilling(
    symbol="BTCUSDT",
    timeframe="1h",
    from_date="2024-01-01",
    to_date="2024-12-31"
)

backfiller.register_emitter(postgres_emitter)
backfiller.run()

With Transformer¶

def my_transformer(data: dict) -> dict:
    return {...data, "custom_field": value}

backfiller.set_transformer(my_transformer)
backfiller.run()

Back to API Reference →