API Reference

Complete API documentation for StreamForge, auto-generated from source code.

---

Overview

StreamForge's API is organized into several key modules:

• Runners

  Main entry points for streaming data

• Emitters

  Output destinations for data

• Data Models

  Data structures and schemas

• Backfilling

  Historical data loading

---

Quick Reference

Import Statement

import streamforge as sf

Main Classes

Class	Module	Purpose
BinanceRunner	streamforge	Binance streaming
KrakenRunner	streamforge	Kraken streaming
OKXRunner	streamforge	OKX streaming
DataInput	streamforge	Stream configuration
Logger	streamforge	Console output
CSVEmitter	streamforge.base.emitters.csv	CSV file output
PostgresEmitter	streamforge	PostgreSQL output
KafkaEmitter	streamforge	Kafka streaming
Kline	streamforge	OHLC data model
BinanceBackfilling	streamforge	Binance backfilling
OkxBackfilling	streamforge	OKX backfilling

---

Type Hints

StreamForge is fully type-hinted for better IDE support:

from streamforge import DataInput, BinanceRunner
from streamforge.base.normalize.ohlc.models.candle import Kline

def process_kline(kline: Kline) -> None:
    price: float = kline.close
    symbol: str = kline.symbol

---

Explore the API

• Runners → - Exchange-specific runners
• Emitters → - Output destinations
• Data Models → - Data structures
• Backfilling → - Historical data

---

Source Code

Browse the source code on GitHub:

View Source →