Skip to content

Developer Resources

Everything below links to GitHub repositories where full technical documentation lives. This site is your starting point — the repos are where you go deep.

Architecture Deep Dives

These documents live in the meridian-core repository:

  • Kernel Model — Order lifecycle, event sourcing, the state machine that powers OMS/EMS/BOR
  • Sidecar Protocol — Startup sequence, ACL enforcement, health monitoring, schema translation
  • Plugin Specifications — Pub/sub topics, required hooks, lifecycle states, container contract

Start with the kernel model

Understanding how Meridian's event-sourced kernel works will make everything else click. Orders, fills, positions, and balances are all projections over the same event stream.

SDK References

  • Python SDK — Full API reference, LocalClient, SignalEngine base class, examples
  • Go SDK — Full API reference, plugin lifecycle, idiomatic Go patterns
  • Field Catalog — 62 canonical field constants (identifiers, prices, reference data, fixed income, derivatives, fundamentals, compliance) available via meridian.fields in Python and meridian.Field* in Go. See Data Query API

Guides

Each guide lives alongside the relevant codebase in GitHub:

  • Building a Broker Adapter — CCM implementation walkthrough, FIX protocol patterns
  • Container Contract — Environment variables, network model, startup sequence, health checks
  • Conformance Tests — Comprehensive automated testing to ensure your plugin thrives in the ecosystem
  • Deploying to Production — Bus backends, storage configuration, ACL setup, monitoring

API Surfaces

The kernel exposes four API surfaces. All operations are available through every SDK.

Surface Operations Scope
OMS API 22 operations Order creation, amendment, cancellation, allocation, compliance
EMS API 19 operations Execution strategies, child orders, venue routing, fill management
BOR API 37 operations Positions, balances, transactions, settlement, reconciliation
Adapter API 6 operations DGM, CCM, and Signal convenience methods for common patterns

Tools

  • Meridian CLI (Apache 2.0) — Scaffold plugins (meridian new), run tests (meridian test), publish to the marketplace (meridian publish), diagnose setup (meridian doctor). Supports 6 Python templates: signal, dgm, ccm, oms, ems, portfolio.
  • Dev Environment — Docker-based full-stack setup with NATS, TimescaleDB, and example plugins

API Documentation (coming soon)

Language-specific API docs will be hosted alongside this site:

  • Python API Docs — Sphinx-generated, hosted at open-meridian.dev/docs/python/
  • Go API Docs — GoDoc-generated, hosted at open-meridian.dev/docs/go/