Skip to main content

Quickstart

cURL
curl --request GET \
  --url 'https://api.forecast.example/api/v1/markets?view=matched&source=kalshi&limit=25' \
  --header 'Authorization: Bearer YOUR_API_KEY'
{
  "markets": [
    {
      "canonical_id": "KXBTCD-EXAMPLE",
      "confidence": 0.97,
      "category": "crypto",
      "is_active": true
    }
  ],
  "count": 1,
  "total": 1,
  "view": "matched",
  "generated_at": 1761868800000
}
Forecast splits the platform into three surfaces:

Historical Data

Backtest-grade archive products for trades, candles, markets, and later order books.

Realtime Data

Low-latency reads for markets, ticks, and order-book snapshots.

Product APIs

Authenticated workspace objects like backtests, bots, and strategies.

Choose an auth mode

Use API keys for market data reads and archive access. This is the clean external model for public and paid data products.

Start with one endpoint

If you want the fastest first integration, start with GET /api/v1/markets and one view:
  • matched for the most useful live market list
  • resolving for a narrower operational slice

Multi-language examples

curl --request GET \
  --url 'https://api.forecast.example/api/v1/ticks?symbol=KXBTCD-26JUN1420&limit=500' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Authentication

Header formats, public vs private auth, and the recommended external contract.

API Reference

The manual endpoint pages with parameters, request examples, and response shapes.