docs

openrate documentation

Everything you need to run, consume, embed, and extend openrate.

New here? Quickstart has one starting point per audience, and Which mode should I choose is a page long and settles the library-vs-sidecar question before you write any code.

Start here

Guide	What's inside
Quickstart	Five starting points: see it work, run it as a service, embed it in Go, call it from another language, or bring your own rates
Which mode should I choose	Library, CLI, sidecar or C ABI — the decision, with measured cost and size for each
Troubleshooting	Symptoms in the order they happen, and what each one actually means

Embedding

Guide	What's inside
Embed as a Go library	Engine, Refresher, fx, fxsource, serve, the noui tag — the full reference
Proving it sends nothing	The headline property: an Engine constructed with the feature off sends zero packets, counted with a control
Use it from another language	The C ABI, its honest costs, the fifteen language packages, and why the sidecar is usually the better answer

Running the server

Guide	What's inside
Configuration	Flags, environment variables, and the source spec
API reference	Every endpoint, query params, and full response shapes
Web UI	The embedded, dependency-free HTML console (converter + rates board)

The numbers

Guide	What's inside
The graph model	Why openrate models currencies as a graph, not a base
Accuracy & quality	How grades, confidence, corroboration and caveats are computed
Sources	Full source catalog, cadence, and freshness notes
Interest rates	The optional policy/reference-rate engine under /api/v1/interest/* — internal/ and serve-only

Elsewhere in the repository

Document	Purpose
sdks/README.md	The language index — fifteen packages (bun, C, C++, Deno, .NET, Elixir, Go, Java, Kotlin, Node, PHP, Python, Ruby, Rust, Swift). All fifteen offer the sidecar; all but Elixir also offer an in-process path (Elixir has none, deliberately — a NIF cannot be killed or timed out). The index names the right default for each language
ffi/README.md	The C ABI reference: every function, the memory rules, the measured numbers
SECURITY.md	Disclosure policy
CHANGELOG.md	Release history
ROADMAP.md	What is planned, and what is deliberately not
License OR Apache-2.0	Dual-licensed MIT OR Apache-2.0