Skip to content
Worldview
Get started

API Reference

The S9 gateway exposes 55+ documented endpoints for market data, news, alerts, chat, and more.

On this page (6)

Worldview's S9 API Gateway is the single entry point for programmatic access to all platform data. Every authenticated route requires a JWT issued by Zitadel.

Base URL

https://api.worldview.app/v1

For local development:

http://localhost:8000/v1

Authentication

All requests need an Authorization: Bearer <jwt> header. Issue a token via the OIDC PKCE flow or, for development, via POST /v1/auth/dev-login.

curl -X POST https://api.worldview.app/v1/auth/dev-login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com"}'
# Returns: { "access_token": "...", "token_type": "bearer", "expires_in": 3600 }

Common response shapes

List endpoints return a paginated envelope:

{
  "items": [...],
  "total": 142,
  "has_more": true,
  "page": 1,
  "page_size": 20
}

Single-resource endpoints return the bare object.

Error responses always include a detail field:

{
  "detail": "Instrument not found",
  "code": "INSTRUMENT_NOT_FOUND",
  "status": 404
}

Rate limits

Rate limits

Free tier: 60 requests/minute per token. Pro: 600/min. Enterprise: custom. Exceeded limits return 429 Too Many Requests with a Retry-After header in seconds.

Endpoint groups

GroupPrefixDescription
Auth/v1/authToken issuance, OIDC, dev-login
Instruments/v1/instrumentsSearch, OHLCV, fundamentals, live quote
News/v1/newsTop articles, entity articles
Portfolio/v1/portfolioHoldings, transactions, watchlists
Screener/v1/screenerScreen instruments with filters
Alerts/v1/alertsCRUD alert rules, WebSocket
Chat/v1/chatRAG threads and streaming
Feedback/v1/feedbackSubmissions, NPS, feature requests
Knowledge Graph/v1/graphEntity relationships

Was this page helpful?

Last updated