Introduction
The Whether API provides programmatic access to market regime assessments, Treasury yield data, and regime change alerts. All endpoints return JSON responses with consistent metadata fields.Base URL
Authentication
Currently, the API endpoints are publicly accessible and do not require authentication.Response Format
All API responses follow a consistent JSON structure with standard metadata fields:ISO 8601 timestamp indicating when the response was generated
API version identifier (e.g., “v1”)
Common Data Fields
Many endpoints return data with these shared metadata fields:Data source identifier (e.g., “US_TREASURY”, “FRED”)
ISO 8601 date of the actual data observation
ISO 8601 timestamp when the data was retrieved
Whether the data represents live/current values or fallback data
Caching
Endpoints implement edge caching with different revalidation periods:/api/treasury: 24 hours (86400 seconds)/api/monthly,/api/quarterly,/api/yearly,/api/cadence: 1 hour (3600 seconds)/api/regime-alerts,/api/weekly-digest: Dynamic (no static cache)
Error Handling
API errors return standard HTTP status codes:200 OK: Successful request400 Bad Request: Invalid parameters500 Internal Server Error: Server-side error
Rate Limiting
Currently, there are no enforced rate limits on API endpoints. However, please be respectful with request frequency as endpoints are cached appropriately.Available Endpoints
- Treasury Data - Current Treasury yield curve
- Regime Alerts - Market regime change alerts
- Weekly Digest - Weekly regime summary
- Monthly Summary - Monthly regime analysis
- Quarterly Summary - Quarterly regime analysis
- Yearly Summary - Yearly regime analysis
- Cadence Alignment - Cross-timeframe alignment validation
- Agent Interface - Programmatic access for AI agents
- Webhook Integration - Real-time regime change notifications