Omen Developer Portal
API Reference
Options Gateway Health
Detailed reference for endpoints, authentication, channels, messages, environment endpoints, and data models in this integration area.
OpenAPI referencev0.1.1Options
Omen Options Gateway Health API
HTTP health and latency endpoints exposed by `options-gatewayd`. Order entry, cancels, amendments, account state reads, and market-data reads are not exposed over HTTP. Those client-facing commands use the gateway WebSocket contract in `docs/asyncapi.yaml`. In the test cluster, these endpoints are used as ALB/Kubernetes health checks on the service health port. The public gateway ingress routes `options.test.omen.tra
Environment endpoints
Local development gateway health port (`OPTIONS_GATEWAY_HEALTH_ADDR`)
http://localhost:3002Local development gateway health port (`OPTIONS_GATEWAY_HEALTH_ADDR`)Endpoints
| Method | Path | Summary | Tags |
|---|---|---|---|
| GET | /health | Gateway liveness and hot-path counters | Health |
| GET | /health/latency | Structured gateway latency snapshot | Health |
Data models
RingMetricsLatencyStageGatewayLatencySnapshot