API reference

The FerroMatch API reference covers the deterministic matching core, binary I/O primitives, and memory-mapped journal. Server orchestration, admission, recovery, publisher topology, and stress tooling are internal runtime surfaces and are intentionally not published.

API bundles

• ferromatch_core — order book, matching engine, commands, events, and domain types.
• ferromatch_io — binary codec and ring-buffer primitives.
• ferromatch_journal — append-only event journal and replayable persistence contracts.

Start here

• Getting started walks through a deterministic match cycle.
• Matching cycle example shows the command/event boundary used by replay and journaling.