Binary RPC API

This page retains its historical filename so existing documentation links keep working. Forge no longer exposes a REST or JSON business API.

Transport contract

Unary business operations use Connect over HTTP with binary Protobuf:

POST /aurum.forge.v1.ForgeService/GetHealth
Content-Type: application/proto
Connect-Protocol-Version: 1

Use a generated Connect client with binary format enabled. Connect status and error metadata are the only HTTP-level signaling; business payloads remain Protobuf.

Forge services

aurum.forge.v1.ForgeService

Gateway information, health, and doctor checks.

aurum.forge.v1.InstanceService

Instance inventory, lookup, lifecycle actions, and logs.

aurum.forge.v1.DiscoveryService

Typed metrics target discovery for clients. Prometheus itself uses Forge’s internal file-discovery driver.

aurum.forge.v1.DatasourceService

Datasource availability summaries.

aurum.forge.v1.RuntimeService

Typed runtime status, resources, and query results.

History service

aurum.history.v1.HistoryService provides typed methods for datasource metadata, history instances, recent fills, runs, resources, storage facts, summary, portfolio series and metrics, market bars, and controlled table preview. It does not accept arbitrary SQL.

Run selection is explicit. An empty run_id asks Forge to resolve the latest run from canonical metadata; the literal string current is not a protocol sentinel.

Metrics exception

GET /metrics and GET /metrics/instances/{port} return Prometheus text. They are monitoring endpoints, not business APIs.