REST API documentation
Full reference. Base URL: https://api.northflow.no/v1. JSON responses. OAuth2 + API key auth. OpenAPI spec available.
Authentication
All requests require an X-API-Key header. Generate keys in /norse/keys. Keys scope: norse:read, argus:read, aegis:read, comply:read.
Rate limits
Explorer: 60/min · Professional: 600/min · Intelligence: 6,000/min · Enterprise: custom. Bursts up to 2x for 10s.
Errors
JSON error responses: { error: { code, message, requestId } }. Codes: 401 unauthorized, 403 forbidden, 404 not found, 429 rate limited, 5xx server.
Pagination
Cursor-based via ?cursor=... or page-based via ?page=&limit=. Default limit 20, max 200.
Webhooks
Alert deliveries can be configured per alert rule. Signed with HMAC-SHA256, retries with exponential backoff up to 24h.
SDKs
Official SDKs: TypeScript (npm @northflow/sdk), Python (pip northflow). Community: Go, Rust.
NORSE endpoints
- GET/v1/norse/entities
- GET/v1/norse/entities/{ticker}
- GET/v1/norse/entities/{ticker}/relations
- GET/v1/norse/filings
- GET/v1/norse/markets/indices
- GET/v1/norse/markets/sectors
AEGIS endpoints
- GET/v1/aegis/events
- GET/v1/aegis/events/{id}
- GET/v1/aegis/regions
- GET/v1/aegis/cascade/{eventId}
- GET/v1/aegis/portfolio-exposure
COMPLY endpoints
- GET/v1/comply/portfolios
- GET/v1/comply/portfolios/{id}
- GET/v1/comply/holdings/{id}
- POST/v1/comply/reports
- GET/v1/comply/regulatory
ARGUS endpoints
- GET/v1/argus/hypotheses
- GET/v1/argus/hypotheses/{id}
- GET/v1/argus/signals
- GET/v1/argus/scorecard
- GET/v1/argus/smart-money/{ticker}
- GET/v1/argus/regime
Platform endpoints
- GET/v1/platform/brief/today
- GET/v1/platform/twin/status
- POST/v1/platform/war-room/simulate
- GET/v1/verify/{hash}