API reference

The generated API reference for FerroFeed is hosted in the canonical docs site. It covers the normalized market-event model, exchange connectors, sink contracts, runtime configuration, metrics, and archive/control surfaces.

API bundle

• ferro_feed — market-event models, connector traits, output sinks, Redis/shm/file/stdout adapters, control watcher types, and runtime configuration.

Start here

• Getting started shows the runtime configuration path and a minimal sink setup.
• Redis sink example shows the normalized event stream shape that downstream engines consume.