API Reference
Forecast should document endpoints in two layers:Narrative API pages
Handcrafted endpoint pages explain intent, caveats, common query patterns, and real request or response examples.
Schema-backed reference
OpenAPI provides the canonical machine-readable contract for generated references, SDKs, and future testing surfaces.
What makes a strong endpoint page
- A short introduction that explains when to use the endpoint
- One request pinned in the sidebar
- One response pinned in the sidebar
- Typed request fields
- Typed response fields
- Multi-language examples for the most common path
- Clear notes about what is live today versus still planned
Current reference groups
Realtime Data
Market lists, tick windows, and latest order-book snapshots.
Product APIs
User backtests, research runs, bots, and strategy objects.
Schema strategy
Right now the best pattern for Forecast is:- Use manual MDX endpoint pages for the high-value public surfaces.
- Keep the OpenAPI file alongside them as the contract seed.
- Expand the schema over time until autogenerated API sections become worthwhile.