// API Reference
Interactive API Explorer
Complete reference for the Polaris Knowledge API. Base URL: https://api.thepolarisreport.com|Full Docs|Get API Key
// Authentication
The Polaris API supports two authentication methods. Most endpoints work without auth (using the demo key) but with lower rate limits.
API Key (Recommended)
Pass your API key via the Authorization header or query parameter. Get keys from the developer portal.
Header (preferred)
Authorization: Bearer pr_live_xxx
Query parameter
?api_key=pr_live_xxx
JWT Bearer Token
For browser-based apps. Obtain a token via POST /auth/login and pass it in the Authorization header. Tokens expire after 7 days.
Authorization: Bearer eyJhbGciOi...
Try instantly -- no signup
Use api_key=demo on any read endpoint. Limited to 1,000/month and 10/min.
// Rate Limits
Per-minute rate limits apply to all requests. Monthly limits depend on your plan. Every response includes rate limit headers.
Per-Minute Limits
| Free / Demo | 10 req/min |
| Builder | 120 req/min |
| Startup | 300 req/min |
| Growth | 600 req/min |
| Scale | 1,200 req/min |
Monthly Limits
| Free | 1,000 credits |
| Builder ($24) | 5,000 credits |
| Startup ($79) | 15,000 credits |
| Growth ($179) | 40,000 credits |
| Scale ($399) | 100,000 credits |
Response Headers
RateLimit-LimitMaximum requests allowed in the current windowRateLimit-RemainingRequests remaining in the current windowRateLimit-ResetSeconds until the rate limit window resets// Pricing & Credits
Every API call costs credits. Each endpoint has a credit cost shown in its documentation. Plan credits are included at a discount; overage credits and pay-as-you-go are billed at a premium rate.
Credit Costs by Endpoint Type
| Endpoint | Credits |
|---|---|
| Feed, Search, Brief, Ticker, Price, Entities, Forex, Commodities | 1 |
| Technicals, Financials, Economy, Sentiment History, Signals, DeFi, Earnings | 2 |
| Verify (fact-check) | 3 |
| Context, Research | 5 |
| Composite Score | 5 |
| Intelligence (cross-category) | 8 |
| Forecast (standard) | 15 |
| Portfolio Feed | 17 |
| Forecast (deep) | 95 |
Plan Pricing
Plan credits: ~$0.004-0.005/credit effective rate. Included credits reset monthly.
Overage / Pay-as-you-go
$0.008/credit for plan overage. $0.01/credit for no-plan pay-as-you-go. Configure a spending cap via the billing endpoint.
// Quick Start
Get up and running in under a minute. Use the demo key to explore, or sign up and create an API key for full access.
# Search for AI news curl "https://api.thepolarisreport.com/api/v1/search?q=AI+regulation&api_key=demo" # Get the latest feed curl "https://api.thepolarisreport.com/api/v1/feed?per_page=5&api_key=demo" # Get a stock ticker with live price curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA?api_key=demo" # Get market summary curl "https://api.thepolarisreport.com/api/v1/market/summary?api_key=demo" # With your API key (once you sign up) curl -H "Authorization: Bearer pr_live_YOUR_KEY" \ "https://api.thepolarisreport.com/api/v1/search?q=quantum+computing"
// Intelligence
/api/v1/feedList Feed
Get paginated published briefs. Returns the main news feed with full brief data, sources, provenance, and bias analysis. Briefs are living documents that get richer as more sources cover the same story.
Query Parameters
pagenumberPage number (default: 1)
per_pagenumberResults per page (default: 20, max: 50)
categorystringFilter by category slug (e.g. ai_ml, markets, crypto)
sortstringSort order: published (default) or updated
updates_onlybooleanOnly briefs updated with new sources since creation
| Name | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number (default: 1) |
| per_page | number | No | Results per page (default: 20, max: 50) |
| category | string | No | Filter by category slug (e.g. ai_ml, markets, crypto) |
| sort | string | No | Sort order: published (default) or updated |
| updates_only | boolean | No | Only briefs updated with new sources since creation |
curl "https://api.thepolarisreport.com/api/v1/feed?page=1&per_page=5&category=ai_ml" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"briefs": [
{
"id": "a1b2c3d4-...",
"headline": "EU Passes Comprehensive AI Act",
"summary": "The European Union has finalized...",
"body": "Full article body...",
"category": "policy",
"published_at": "2026-03-09T12:00:00Z",
"confidence_score": 0.92,
"bias_score": 0.08,
"sources": [
{ "name": "Reuters", "url": "https://...", "trust_level": "high" }
],
"update_count": 3,
"updated_at": "2026-03-17T18:30:00Z"
}
],
"meta": { "total": 150, "page": 1, "per_page": 20 }
}Try It
Click Send Request to see response
/api/v1/agent-feedAgent Feed
Optimized feed for AI agents. Returns structured briefs with confidence scores, bias analysis, and source provenance. Best endpoint for agent consumption.
Query Parameters
limitnumberMax results (default: 20, max: 50)
categorystringFilter by category
min_confidencenumberMinimum confidence score (0-1)
tagsstringComma-separated tags filter
| Name | Type | Required | Description |
|---|---|---|---|
| limit | number | No | Max results (default: 20, max: 50) |
| category | string | No | Filter by category |
| min_confidence | number | No | Minimum confidence score (0-1) |
| tags | string | No | Comma-separated tags filter |
curl "https://api.thepolarisreport.com/api/v1/agent-feed?limit=5&category=ai_ml" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"briefs": [
{
"id": "a1b2c3d4-...",
"headline": "...",
"summary": "...",
"category": "ai_ml",
"confidence_score": 0.95,
"bias_score": 0.05,
"source_count": 4,
"published_at": "2026-03-09T12:00:00Z"
}
],
"meta": { "count": 20 }
}Try It
Click Send Request to see response
/api/v1/searchSearch Briefs
Intelligent full-text search with weighted ranking, highlights, facets, and related queries. Handles natural language queries and long phrases. Supports three speed tiers: fast (sub-100ms, no highlights), standard (default), and deep (entity cross-references + source verification).
Query Parameters
qstringrequiredSearch query (min 2 chars)
pagenumberPage number (default: 1)
per_pagenumberResults per page (default: 20, max: 50)
sortstringSort: relevance, newest, oldest, confidence, most_sources
categorystringFilter by category slug
min_confidencenumberMinimum confidence score (0-1)
depthstringSpeed tier: fast | standard | deep (default: standard)
fromstringStart date (YYYY-MM-DD)
tostringEnd date (YYYY-MM-DD)
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search query (min 2 chars) |
| page | number | No | Page number (default: 1) |
| per_page | number | No | Results per page (default: 20, max: 50) |
| sort | string | No | Sort: relevance, newest, oldest, confidence, most_sources |
| category | string | No | Filter by category slug |
| min_confidence | number | No | Minimum confidence score (0-1) |
| depth | string | No | Speed tier: fast | standard | deep (default: standard) |
| from | string | No | Start date (YYYY-MM-DD) |
| to | string | No | End date (YYYY-MM-DD) |
curl "https://api.thepolarisreport.com/api/v1/search?q=AI%20regulation&page=1&per_page=5&category=ai_ml&depth=standard" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"query": "AI regulation",
"total": 847,
"took_ms": 47,
"briefs": [{
"id": "...",
"headline": "EU Enforces AI Act...",
"search_score": 0.82,
"highlights": {
"headline": "EU Enforces <mark>AI</mark> Act...",
"summary": "...new <mark>regulation</mark>s..."
}
}],
"facets": { "ai_ml": 124, "policy": 89, "markets": 45 },
"related_queries": ["AI Act enforcement", "GPT-5 regulation"],
"meta": { "total": 847, "page": 1, "per_page": 20, "sort": "relevance" }
}Try It
Click Send Request to see response
/api/v1/brief/:idGet Brief
Get a single brief by ID with full details including body, sources, bias analysis, counter-arguments, and living brief metadata.
Path Parameters
idstringrequiredBrief ID (e.g. PR-2026-0305-001)
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Brief ID (e.g. PR-2026-0305-001) |
Query Parameters
include_full_textbooleanInclude full extracted article text from raw sources
| Name | Type | Required | Description |
|---|---|---|---|
| include_full_text | boolean | No | Include full extracted article text from raw sources |
curl "https://api.thepolarisreport.com/api/v1/brief/:id" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"brief": {
"id": "a1b2c3d4-...",
"headline": "EU Passes Comprehensive AI Act",
"summary": "...",
"body": "Full article body...",
"category": "tech",
"confidence_score": 0.92,
"bias_analysis": {
"bias_score": 0.08,
"direction": "neutral",
"framing_notes": "..."
},
"counter_argument": "...",
"sources": [...],
"update_count": 3,
"is_living": true,
"story_age_hours": 42.5,
"last_updated_label": "Updated 2h ago"
}
}Try It
Click Send Request to see response
/api/v1/verifyVerify Claim
Fact-check a claim against the Polaris brief corpus. Returns a verdict (supported, contradicted, partially_supported, or unverifiable) with confidence score, supporting/contradicting briefs, and nuances.
Request Body (JSON)
claimstringrequiredThe claim to verify (10-1000 characters)
contextstringCategory to narrow the search (e.g. tech, policy, markets)
| Name | Type | Required | Description |
|---|---|---|---|
| claim | string | Yes | The claim to verify (10-1000 characters) |
| context | string | No | Category to narrow the search (e.g. tech, policy, markets) |
curl -X POST "https://api.thepolarisreport.com/api/v1/verify" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{
"claim": "AI companies are investing billions in new data centers"
}'Example Response
{
"status": "ok",
"claim": "AI companies are investing billions in new data centers",
"verdict": "supported",
"confidence": 0.85,
"summary": "Multiple briefs confirm substantial AI infrastructure investments...",
"supporting_briefs": [
{ "id": "PR-xxx", "headline": "...", "confidence": 0.94, "relevance": 0.92 }
],
"contradicting_briefs": [],
"nuances": "Evidence focuses on specific companies rather than industry-wide totals.",
"sources_analyzed": 12,
"credits_used": 3,
"processing_time_ms": 3200
}Try It
Click Send Request to see response
/api/v1/researchDeep Research
Expands a query into sub-queries, searches existing briefs in parallel, aggregates entities with co-occurrence tracking, and synthesizes a comprehensive research report via LLM. Requires Growth plan or above.
Request Body (JSON)
querystringrequiredResearch query (max 500 chars)
max_sourcesnumberMaximum briefs to analyze (1-50, default: 20)
depthstringResearch depth: standard or deep (default: standard)
categorystringFilter briefs by category slug
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Research query (max 500 chars) |
| max_sources | number | No | Maximum briefs to analyze (1-50, default: 20) |
| depth | string | No | Research depth: standard or deep (default: standard) |
| category | string | No | Filter briefs by category slug |
curl -X POST "https://api.thepolarisreport.com/api/v1/research" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{
"query": "Impact of EU AI Act on US tech companies",
"max_sources": 20,
"depth": "standard",
"category": "ai_ml"
}'Example Response
{
"status": "ok",
"query": "Impact of EU AI Act on US tech companies",
"report": {
"summary": "The EU AI Act represents...",
"key_findings": ["Finding 1", "Finding 2"],
"analysis": "Detailed analysis...",
"confidence_assessment": "High confidence based on 15 sources",
"information_gaps": ["Limited data on SME impact"]
},
"sources_used": [
{ "brief_id": "abc-123", "headline": "...", "confidence": 0.92 }
],
"entity_map": [
{ "name": "European Union", "type": "organization", "mentions": 12 }
],
"metadata": {
"briefs_analyzed": 15,
"processing_time_ms": 4200
}
}Try It
Click Send Request to see response
/api/v1/forecastForecast
Generate structured predictions on any topic. Returns an executive summary, ranked predictions with confidence scores, key signals to watch, and wildcards. MPP-gated.
Request Body (JSON)
topicstringrequiredTopic to forecast (e.g. 'AI chip supply chain')
depthstringDepth: standard ($0.15) or deep ($0.95)
periodstringHistorical lookback period (e.g. 30d, 90d)
timeframestringForecast horizon (e.g. '6 months', '1 year')
| Name | Type | Required | Description |
|---|---|---|---|
| topic | string | Yes | Topic to forecast (e.g. 'AI chip supply chain') |
| depth | string | No | Depth: standard ($0.15) or deep ($0.95) |
| period | string | No | Historical lookback period (e.g. 30d, 90d) |
| timeframe | string | No | Forecast horizon (e.g. '6 months', '1 year') |
curl -X POST "https://api.thepolarisreport.com/api/v1/forecast" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{
"topic": "AI chip supply chain",
"depth": "standard",
"period": "30d",
"timeframe": "6 months"
}'Example Response
{
"forecast": {
"executive_summary": "AI chip demand will likely outpace supply through Q3...",
"predictions": [
{
"prediction": "NVIDIA maintains 80%+ data center GPU share",
"confidence": 0.85,
"timeframe": "6 months"
}
],
"key_signals_to_watch": [
"TSMC capacity announcements",
"AMD MI400 benchmarks"
],
"wildcards": ["Chinese export controls escalation"],
"trend_direction": "accelerating",
"depth": "standard"
}
}Try It
Click Send Request to see response
/api/v1/contextTopic Context
Structured background intelligence on any topic. Returns an LLM-synthesized executive summary, supporting/opposing perspectives, timeline, entity network, key facts, and confidence scoring. The ultimate endpoint for giving an AI agent full context on any world event.
Query Parameters
topicstringrequiredThe topic to get context on (min 2 chars)
periodstringTime window: 7d, 30d, or 90d (default: 30d)
| Name | Type | Required | Description |
|---|---|---|---|
| topic | string | Yes | The topic to get context on (min 2 chars) |
| period | string | No | Time window: 7d, 30d, or 90d (default: 30d) |
curl "https://api.thepolarisreport.com/api/v1/context?topic=AI%20chip%20supply%20chain&period=30d" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"topic": "Iran war",
"summary": "A significant military conflict...",
"perspectives": {
"supporting": "Military escalation is accelerating...",
"opposing": "Diplomatic channels remain open...",
"neutral": "Analysts note the conflict's impact on global energy..."
},
"timeline": [
{ "date": "2026-03-18T19:00:00Z", "headline": "Fed holds rates...", "confidence": 0.85 }
],
"key_entities": [
{ "name": "Iran", "type": "location", "mentions": 89, "sentiment_label": "negative" }
],
"relationships": [
{ "from": "Iran", "to": "United States", "strength": 45 }
],
"key_facts": [
{ "value": "$88", "context": "oil price per barrel", "type": "price" }
],
"confidence": 0.7,
"source_count": 30
}Try It
Click Send Request to see response
/api/v1/intelligenceCross-Category Intelligence
Cross-category impact analysis. Shows how a topic ripples across verticals -- from a defense event to energy prices to market reactions. Includes causal chain analysis, entity networks, trend detection, and LLM-generated counter-narratives and predictions.
Query Parameters
topicstringrequiredThe topic to analyze (min 2 chars)
periodstringTime window: 7d, 30d, or 90d (default: 30d)
| Name | Type | Required | Description |
|---|---|---|---|
| topic | string | Yes | The topic to analyze (min 2 chars) |
| period | string | No | Time window: 7d, 30d, or 90d (default: 30d) |
curl "https://api.thepolarisreport.com/api/v1/intelligence?topic=AI%20chip%20supply%20chain&period=30d" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"topic": "Iran war",
"categories_affected": 6,
"cross_category_impact": [
{ "category": "defense", "brief_count": 18, "dominant_sentiment": "negative" },
{ "category": "energy", "brief_count": 12, "dominant_sentiment": "negative" },
{ "category": "markets", "brief_count": 9, "dominant_sentiment": "negative" }
],
"causal_chain": [
{ "date": "2026-03-15T...", "category": "defense", "headline": "Iran strike..." },
{ "date": "2026-03-16T...", "category": "energy", "headline": "Oil spikes..." }
],
"causal_analysis": "Military strikes caused immediate oil price spikes...",
"prediction": "Watch for OPEC emergency meeting responses...",
"confidence": 0.72
}Try It
Click Send Request to see response
// Trading
/api/v1/ticker/:symbolTicker Lookup
Look up a stock ticker. Returns entity name, exchange, sector, asset type, 24h brief count, current sentiment, trending status, and real-time price data.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA, AAPL, BTC)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA, AAPL, BTC) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"entity_name": "Nvidia",
"exchange": "NASDAQ",
"asset_type": "equity",
"sector": "Semiconductors",
"briefs_24h": 7,
"sentiment_score": 0.65,
"trending": true,
"price": {
"current": 172.70,
"change_pct": -4.19,
"market_state": "CLOSED",
"currency": "USD",
"updated_at": "2026-03-21T20:00:00Z"
}
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/priceLive Price
Lightweight price-only endpoint. Returns current price, change percentage, and market state. 15s cache on paid plans, 60s on free.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA, AAPL)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA, AAPL) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/price" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"price": 172.70,
"change_pct": -4.19,
"market_state": "CLOSED",
"currency": "USD",
"updated_at": "2026-03-21T20:00:00Z"
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/scoreComposite Score
Composite trading signal combining sentiment velocity, momentum, volume, and events. Returns a 0-1 score with component breakdown and signal label.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/score" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"composite_score": 0.72,
"signal": "bullish",
"components": {
"sentiment": { "current_24h": 0.8, "week_avg": 0.48, "weight": 0.4 },
"momentum": { "value": 0.35, "direction": "accelerating", "weight": 0.25 },
"volume": { "briefs_24h": 7, "velocity_change_pct": 40, "weight": 0.2 },
"events": { "count_7d": 1, "latest_type": "earnings", "weight": 0.15 }
}
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/historySentiment History
Daily sentiment timeseries for a ticker. Returns average, min, max sentiment per day with brief counts. Useful for charting sentiment trends over time.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA) |
Query Parameters
daysnumberLookback period in days (default: 30, max: 365)
| Name | Type | Required | Description |
|---|---|---|---|
| days | number | No | Lookback period in days (default: 30, max: 365) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/history?days=30" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"entity_name": "Nvidia",
"history": [
{
"date": "2026-03-20",
"avg_sentiment": 0.65,
"min_sentiment": 0.3,
"max_sentiment": 0.9,
"brief_count": 5,
"avg_confidence": 0.82
}
]
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/signalsSentiment Signals
Detect sentiment shifts for a ticker. Returns days where sentiment moved beyond a threshold, with streak tracking and trigger headlines.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA) |
Query Parameters
daysnumberLookback period (default: 30)
thresholdnumberMinimum shift to flag (default: 0.3)
| Name | Type | Required | Description |
|---|---|---|---|
| days | number | No | Lookback period (default: 30) |
| threshold | number | No | Minimum shift to flag (default: 0.3) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/signals?days=30&threshold=0.3" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"signals": [
{
"date": "2026-03-18",
"sentiment_shift": -0.85,
"from": 0.65,
"to": -0.2,
"direction": "bearish",
"brief_count": 5,
"trigger_headline": "Nvidia faces export restrictions..."
}
]
}Try It
Click Send Request to see response
/api/v1/portfolio/feedPortfolio Feed
Send portfolio holdings and get intelligence ranked by relevance to your positions. Returns briefs with portfolio-specific relevance scores and matched holdings.
Request Body (JSON)
holdingsarrayrequiredArray of { ticker, weight, direction } objects
per_pagenumberResults per page (default: 20)
sincestringTime window (e.g. 2h, 24h)
| Name | Type | Required | Description |
|---|---|---|---|
| holdings | array | Yes | Array of { ticker, weight, direction } objects |
| per_page | number | No | Results per page (default: 20) |
| since | string | No | Time window (e.g. 2h, 24h) |
curl -X POST "https://api.thepolarisreport.com/api/v1/portfolio/feed" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{
"per_page": 5
}'Example Response
{
"status": "ok",
"briefs": [
{
"id": "PR-12345",
"headline": "Nvidia announces next-gen B300 GPU architecture",
"portfolio_relevance": {
"score": 0.95,
"matched_holdings": [
{ "ticker": "NVDA", "weight": 0.15, "sentiment_score": 0.85, "impact": "direct_mention" }
]
}
}
],
"portfolio_summary": {
"holdings_with_activity": 8,
"avg_portfolio_sentiment": 0.35
}
}Try It
Click Send Request to see response
/api/v1/sectorsSector Rankings
All sectors ranked by brief volume with average sentiment and signal labels. Useful for sector rotation analysis.
Query Parameters
daysnumberLookback period (default: 7)
| Name | Type | Required | Description |
|---|---|---|---|
| days | number | No | Lookback period (default: 7) |
curl "https://api.thepolarisreport.com/api/v1/sectors?days=30" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"sectors": [
{
"sector": "Semiconductors",
"brief_count": 45,
"avg_sentiment": 0.35,
"signal": "bullish",
"top_ticker": "NVDA"
},
{
"sector": "Oil & Gas",
"brief_count": 32,
"avg_sentiment": -0.2,
"signal": "bearish",
"top_ticker": "XOM"
}
]
}Try It
Click Send Request to see response
// Market Data
/api/v1/ticker/:symbol/candlesCandlestick Data
OHLCV candlestick data for equities. Supports daily, weekly, and monthly intervals with configurable date ranges up to 5 years.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA) |
Query Parameters
intervalstringCandle interval: 1d, 1wk, 1mo (default: 1d)
rangestringDate range: 1mo, 3mo, 6mo, 1y, 2y, 5y (default: 6mo)
| Name | Type | Required | Description |
|---|---|---|---|
| interval | string | No | Candle interval: 1d, 1wk, 1mo (default: 1d) |
| range | string | No | Date range: 1mo, 3mo, 6mo, 1y, 2y, 5y (default: 6mo) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/candles?interval=1d&range=6mo" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"candle_count": 21,
"candles": [
{
"date": "2026-03-20",
"open": 178.0,
"high": 178.26,
"low": 171.72,
"close": 172.70,
"volume": 239998000
}
]
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/technicalsTechnical Indicators
All technical indicators at once with buy/sell/neutral signal summary. Includes SMA 20/50/200, EMA 12/26, RSI, MACD, Bollinger Bands, ATR, Stochastic, ADX, OBV, VWAP.
Path Parameters
symbolstringrequiredTicker symbol (e.g. NVDA)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. NVDA) |
Query Parameters
rangestringDate range: 1mo, 3mo, 6mo, 1y (default: 6mo)
| Name | Type | Required | Description |
|---|---|---|---|
| range | string | No | Date range: 1mo, 3mo, 6mo, 1y (default: 6mo) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/technicals?range=6mo" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "NVDA",
"latest": {
"price": 172.7,
"sma_20": 182.18,
"sma_50": 184.35,
"ema_12": 180.42,
"rsi_14": 37.82,
"macd": { "macd": -2.7, "signal": -1.64, "histogram": -1.06 },
"bollinger": { "upper": 192.9, "middle": 182.18, "lower": 171.46 },
"stochastic": { "k": 5.71, "d": 8.42 }
},
"signal_summary": {
"overall": "sell",
"buy": 2,
"sell": 3,
"neutral": 2,
"total": 7
}
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/earningsEarnings Estimates
Next earnings date with EPS and revenue estimates for a specific ticker.
Path Parameters
symbolstringrequiredTicker symbol (e.g. AAPL)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. AAPL) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/earnings" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "AAPL",
"earnings_date": "2026-04-30",
"eps_estimate": 1.96,
"revenue_estimate": 109085000000,
"revenue_estimate_formatted": "$109.1B",
"fiscal_quarter": "1Q2026"
}Try It
Click Send Request to see response
/api/v1/ticker/:symbol/financialsCompany Financials
Company fundamentals: income statements, balance sheets, key stats (PE, EPS, margins, debt). Equity only, 6hr cache.
Path Parameters
symbolstringrequiredTicker symbol (e.g. AAPL)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Ticker symbol (e.g. AAPL) |
curl "https://api.thepolarisreport.com/api/v1/ticker/NVDA/financials" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"ticker": "AAPL",
"market_cap_formatted": "$3.72T",
"pe_ratio": 31.42,
"eps": 7.91,
"dividend_yield": 0.0044,
"revenue_formatted": "$435.62B",
"profit_margin": 0.2639,
"debt_to_equity": 151.86,
"beta": 1.24,
"fifty_two_week_high": 260.10,
"fifty_two_week_low": 169.21
}Try It
Click Send Request to see response
/api/v1/market/moversMarket Movers
Top 10 gainers, losers, and most active stocks by volume.
curl "https://api.thepolarisreport.com/api/v1/market/movers" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"gainers": [
{ "symbol": "PL", "name": "Planet Labs", "price": 4.52, "change_pct": 28.41, "volume": 12345678 }
],
"losers": [
{ "symbol": "SMCI", "name": "Super Micro", "price": 32.10, "change_pct": -12.5, "volume": 9876543 }
],
"most_active": [
{ "symbol": "NVDA", "name": "Nvidia", "price": 172.70, "change_pct": -4.19, "volume": 239998000 }
]
}Try It
Click Send Request to see response
/api/v1/market/summaryMarket Summary
Major indices snapshot: S&P 500, Nasdaq, Dow Jones, Russell 2000, and VIX.
curl "https://api.thepolarisreport.com/api/v1/market/summary" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"indices": [
{ "symbol": "^GSPC", "name": "S&P 500", "price": 6506.48, "change_pct": -1.90 },
{ "symbol": "^IXIC", "name": "Nasdaq", "price": 19523.40, "change_pct": -2.63 },
{ "symbol": "^DJI", "name": "Dow Jones", "price": 41583.90, "change_pct": -1.69 },
{ "symbol": "^VIX", "name": "VIX", "price": 26.78, "change_pct": 13.91 }
]
}Try It
Click Send Request to see response
// Forex & Commodities
/api/v1/forexAll Forex Pairs
All 7 major forex pairs with live rates and daily change percentages.
curl "https://api.thepolarisreport.com/api/v1/forex" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"pairs": [
{ "pair": "EURUSD", "label": "EUR/USD", "rate": 1.1575, "change_pct": 1.22 },
{ "pair": "USDJPY", "label": "USD/JPY", "rate": 149.32, "change_pct": -0.45 },
{ "pair": "GBPUSD", "label": "GBP/USD", "rate": 1.2940, "change_pct": 0.85 }
]
}Try It
Click Send Request to see response
/api/v1/forex/:pairSingle Forex Pair
Single forex pair rate. Supported pairs: EURUSD, GBPUSD, USDJPY, AUDUSD, USDCAD, USDCHF, NZDUSD.
Path Parameters
pairstringrequiredForex pair (e.g. EURUSD, USDJPY)
| Name | Type | Required | Description |
|---|---|---|---|
| pair | string | Yes | Forex pair (e.g. EURUSD, USDJPY) |
curl "https://api.thepolarisreport.com/api/v1/forex/EURUSD" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"pair": "EURUSD",
"label": "EUR/USD",
"rate": 1.1575,
"change_pct": 1.22
}Try It
Click Send Request to see response
/api/v1/commoditiesAll Commodities
All 10 tracked commodities with live prices and daily change.
curl "https://api.thepolarisreport.com/api/v1/commodities" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"commodities": [
{ "symbol": "gold", "name": "Gold", "price": 4574.90, "change_pct": -8.52, "currency": "USD" },
{ "symbol": "crude", "name": "WTI Crude Oil", "price": 98.23, "change_pct": 2.10, "currency": "USD" },
{ "symbol": "silver", "name": "Silver", "price": 33.80, "change_pct": -2.15, "currency": "USD" }
]
}Try It
Click Send Request to see response
/api/v1/commodities/:symbolSingle Commodity
Single commodity price. Supported: crude, gold, silver, copper, natgas, wheat, corn, coffee, cotton, sugar.
Path Parameters
symbolstringrequiredCommodity slug (e.g. gold, crude, silver)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Commodity slug (e.g. gold, crude, silver) |
curl "https://api.thepolarisreport.com/api/v1/commodities/NVDA" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"symbol": "gold",
"name": "Gold",
"price": 4574.90,
"change_pct": -8.52,
"currency": "USD"
}Try It
Click Send Request to see response
// Economy
/api/v1/economyEconomic Indicators
Summary of 12 key economic indicators including CPI, unemployment rate, Fed funds rate, treasury yields, GDP, retail sales, and more.
curl "https://api.thepolarisreport.com/api/v1/economy" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"indicators": [
{ "name": "Consumer Price Index", "series_id": "CPIAUCSL", "latest_value": 327.46, "latest_date": "2026-02-01" },
{ "name": "Unemployment Rate", "series_id": "UNRATE", "latest_value": 4.4, "latest_date": "2025-12-01" },
{ "name": "10-Year Treasury Yield", "series_id": "DGS10", "latest_value": 4.25, "latest_date": "2026-03-19" },
{ "name": "Fed Funds Rate", "series_id": "FEDFUNDS", "latest_value": 4.33, "latest_date": "2026-02-01" }
]
}Try It
Click Send Request to see response
/api/v1/economy/:indicatorSingle Indicator
Specific economic indicator with historical observations. Slugs: gdp, cpi, core_cpi, unemployment, fed_funds, treasury_10y, treasury_2y, inflation, retail_sales, nonfarm_payroll, consumer_sentiment.
Path Parameters
indicatorstringrequiredIndicator slug (e.g. cpi, gdp, unemployment)
| Name | Type | Required | Description |
|---|---|---|---|
| indicator | string | Yes | Indicator slug (e.g. cpi, gdp, unemployment) |
Query Parameters
limitnumberNumber of observations (default: 10)
| Name | Type | Required | Description |
|---|---|---|---|
| limit | number | No | Number of observations (default: 10) |
curl "https://api.thepolarisreport.com/api/v1/economy/cpi?limit=5" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"name": "Consumer Price Index",
"latest": { "date": "2026-02-01", "value": 327.46 },
"observations": [
{ "date": "2026-02-01", "value": 327.46 },
{ "date": "2026-01-01", "value": 326.588 },
{ "date": "2025-12-01", "value": 325.712 }
]
}Try It
Click Send Request to see response
/api/v1/economy/yieldsYield Curve
Treasury yield curve with spread calculation and inversion detection. Returns 2Y, 5Y, 10Y, and 30Y yields with the 10Y-2Y spread.
curl "https://api.thepolarisreport.com/api/v1/economy/yields" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"yields": [
{ "maturity": "2y", "name": "2-Year Treasury", "yield_pct": 3.79, "date": "2026-03-19" },
{ "maturity": "5y", "name": "5-Year Treasury", "yield_pct": 4.02, "date": "2026-03-19" },
{ "maturity": "10y", "name": "10-Year Treasury", "yield_pct": 4.25, "date": "2026-03-19" },
{ "maturity": "30y", "name": "30-Year Treasury", "yield_pct": 4.83, "date": "2026-03-19" }
],
"spread_10y_2y": 0.46,
"inverted": false
}Try It
Click Send Request to see response
// Crypto
/api/v1/cryptoCrypto Overview
Crypto market overview: total market cap, 24h volume, BTC/ETH dominance, and active cryptocurrency count.
curl "https://api.thepolarisreport.com/api/v1/crypto" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"total_market_cap_formatted": "$2.44T",
"total_volume_formatted": "$69.83B",
"btc_dominance": 56.28,
"eth_dominance": 10.28,
"active_cryptocurrencies": 18050,
"market_cap_change_24h": -1.97
}Try It
Click Send Request to see response
/api/v1/crypto/topTop Tokens
Top tokens ranked by market cap. 200 tracked tokens available including BTC, ETH, SOL, BNB, XRP, ADA, AVAX, DOGE, DOT, LINK.
Query Parameters
limitnumberNumber of tokens (default: 20, max: 50)
| Name | Type | Required | Description |
|---|---|---|---|
| limit | number | No | Number of tokens (default: 20, max: 50) |
curl "https://api.thepolarisreport.com/api/v1/crypto/top?limit=5" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"tokens": [
{
"symbol": "BTC",
"name": "Bitcoin",
"price": 68822,
"market_cap_formatted": "$1.38T",
"change_24h": -2.2,
"change_7d": -4.1,
"market_cap_rank": 1
},
{
"symbol": "ETH",
"name": "Ethereum",
"price": 3420,
"market_cap_formatted": "$412B",
"change_24h": -1.8,
"change_7d": -3.2,
"market_cap_rank": 2
}
]
}Try It
Click Send Request to see response
/api/v1/crypto/:symbolToken Detail
Extended data for a single token including 1h/24h/7d/30d price changes, all-time high, and market cap ranking.
Path Parameters
symbolstringrequiredToken symbol (e.g. BTC, ETH, SOL)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Token symbol (e.g. BTC, ETH, SOL) |
curl "https://api.thepolarisreport.com/api/v1/crypto/NVDA" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"name": "Solana",
"symbol": "SOL",
"price": 87.32,
"market_cap_formatted": "$49.94B",
"volume_24h_formatted": "$2.46B",
"change_1h": -0.3,
"change_24h": -2.54,
"change_7d": -0.17,
"change_30d": 3.73,
"ath": 293.31,
"ath_change_pct": -70.23,
"market_cap_rank": 7
}Try It
Click Send Request to see response
/api/v1/crypto/:symbol/chartToken Price Chart
Price history for a token. Hourly resolution for periods under 2 days, daily for longer periods.
Path Parameters
symbolstringrequiredToken symbol (e.g. BTC, ETH)
| Name | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Token symbol (e.g. BTC, ETH) |
Query Parameters
daysnumberLookback: 1, 7, 14, 30, 90, 180, 365 (default: 30)
| Name | Type | Required | Description |
|---|---|---|---|
| days | number | No | Lookback: 1, 7, 14, 30, 90, 180, 365 (default: 30) |
curl "https://api.thepolarisreport.com/api/v1/crypto/NVDA/chart?days=30" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"symbol": "BTC",
"prices": [
{ "date": "2026-03-15T18:03:04.172Z", "price": 71831.07 },
{ "date": "2026-03-16T18:00:00.000Z", "price": 70245.20 },
{ "date": "2026-03-22T17:29:02.000Z", "price": 68823.32 }
]
}Try It
Click Send Request to see response
/api/v1/crypto/defiDeFi Overview
DeFi overview: total TVL, top protocols by TVL, and chain breakdown. Data sourced from DeFi Llama.
curl "https://api.thepolarisreport.com/api/v1/crypto/defi" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"total_tvl_formatted": "$522.28B",
"top_protocols": [
{ "name": "Aave V3", "tvl_formatted": "$24.62B", "category": "Lending", "change_1d": -2.17 },
{ "name": "Lido", "tvl_formatted": "$18.30B", "category": "Liquid Staking", "change_1d": -1.05 }
],
"chains": [
{ "name": "Ethereum", "tvl_formatted": "$55.06B" },
{ "name": "Solana", "tvl_formatted": "$6.75B" }
]
}Try It
Click Send Request to see response
// Entities & Events
/api/v1/entitiesSearch Entities
Search and list extracted entities across all published briefs. Returns entity names, types, tickers, and mention counts.
Query Parameters
qstringEntity name search (case-insensitive)
typestringFilter by type: person, organization, location, product, event
limitnumberMax results (default: 20, max: 100)
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | No | Entity name search (case-insensitive) |
| type | string | No | Filter by type: person, organization, location, product, event |
| limit | number | No | Max results (default: 20, max: 100) |
curl "https://api.thepolarisreport.com/api/v1/entities?q=AI%20regulation&limit=5" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"entities": [
{ "name": "OpenAI", "type": "organization", "ticker": null, "brief_count": 34, "last_seen": "2026-03-11T08:00:00Z" },
{ "name": "Nvidia", "type": "organization", "ticker": "NVDA", "brief_count": 28, "last_seen": "2026-03-11T06:00:00Z" }
]
}Try It
Click Send Request to see response
/api/v1/entities/:name/briefsEntity Briefs
Get all published briefs that mention a specific entity. Includes a 14-day mention timeline, trend direction, and peak mention count.
Path Parameters
namestringrequiredEntity name (e.g. OpenAI, Nvidia)
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Entity name (e.g. OpenAI, Nvidia) |
Query Parameters
rolestringFilter by entity role: subject, related, mentioned
limitnumberResults per page (default: 20, max: 50)
| Name | Type | Required | Description |
|---|---|---|---|
| role | string | No | Filter by entity role: subject, related, mentioned |
| limit | number | No | Results per page (default: 20, max: 50) |
curl "https://api.thepolarisreport.com/api/v1/entities/OpenAI/briefs?limit=5" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"briefs": [
{ "id": "PR-2026-0305-001", "headline": "OpenAI Launches GPT-5", "category": "ai_ml" }
],
"timeline": [
{ "date": "2026-03-15", "mentions": 5 },
{ "date": "2026-03-14", "mentions": 12 }
],
"trend": "rising",
"peak": 12,
"meta": { "total": 34, "entity": "OpenAI" }
}Try It
Click Send Request to see response
/api/v1/eventsStructured Events
Structured events extracted from briefs. Filter by event type (acquisition, funding, launch, partnership, regulation, lawsuit, IPO, bankruptcy), entity, or category.
Query Parameters
typestringEvent type: acquisition, funding, launch, partnership, regulation, lawsuit, ipo, bankruptcy
subjectstringEntity name involved in the event
categorystringFilter by category slug
periodstringTime window: 24h, 7d, 30d (default: 7d)
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | No | Event type: acquisition, funding, launch, partnership, regulation, lawsuit, ipo, bankruptcy |
| subject | string | No | Entity name involved in the event |
| category | string | No | Filter by category slug |
| period | string | No | Time window: 24h, 7d, 30d (default: 7d) |
curl "https://api.thepolarisreport.com/api/v1/events?category=ai_ml&period=30d" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"events": [
{
"type": "acquisition",
"subject": "Google",
"object": "Wiz",
"value": "$32B",
"date": "2026-03-15",
"brief_id": "PR-xxx",
"headline": "Google Closes $32B Wiz Acquisition",
"confidence": 0.95
}
],
"total": 24
}Try It
Click Send Request to see response
/api/v1/contradictionsContradictions
Briefs with cross-source disagreements. Surfaces stories where outlets report conflicting facts, filtered by severity.
Query Parameters
severitystringSeverity filter: minor, moderate, major
categorystringFilter by category slug
| Name | Type | Required | Description |
|---|---|---|---|
| severity | string | No | Severity filter: minor, moderate, major |
| category | string | No | Filter by category slug |
curl "https://api.thepolarisreport.com/api/v1/contradictions?category=ai_ml" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"contradictions": [
{
"brief_id": "PR-xxx",
"headline": "Conflicting Reports on Tesla Production Numbers",
"severity": "major",
"claims": [
{ "source": "Reuters", "claim": "Production up 12% YoY" },
{ "source": "Bloomberg", "claim": "Production flat vs last quarter" }
],
"polaris_assessment": "Reuters figure refers to annual comparison while Bloomberg uses quarterly..."
}
],
"total": 8
}Try It
Click Send Request to see response
// User & Billing
/api/v1/usageUsage Stats
Get usage statistics for the authenticated user. Returns credits used, remaining balance, per-endpoint breakdown, and spending data. Works with both API key and JWT authentication.
curl "https://api.thepolarisreport.com/api/v1/usage" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"plan": "usage",
"billing_model": "usage",
"calls_today": 1842,
"monthly_limit": 1000,
"calls_this_month": 14500,
"spend_today_usd": 0.84,
"spend_this_month_usd": 4.70,
"spending_cap_usd": 50,
"budget_remaining_usd": 45.30
}Try It
Click Send Request to see response
/api/v1/keys/createCreate API Key
Create a new API key. The raw key is returned only once -- store it securely. Requires JWT authentication. Keys can be scoped to specific endpoints or categories.
Request Body (JSON)
namestringrequiredName for the key (e.g. production, staging)
allowed_endpointsstring[]Restrict to specific endpoints
allowed_categoriesstring[]Restrict to specific categories
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name for the key (e.g. production, staging) |
| allowed_endpoints | string[] | No | Restrict to specific endpoints |
| allowed_categories | string[] | No | Restrict to specific categories |
curl -X POST "https://api.thepolarisreport.com/api/v1/keys/create" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{
"name": "OpenAI"
}'Example Response
{
"status": "ok",
"key": "pr_live_aBcDeFgHiJkLmNoPqRsT...",
"prefix": "pr_live_aBcD",
"name": "production",
"plan": "builder",
"monthly_limit": 5000
}Try It
Click Send Request to see response
/api/v1/keysList API Keys
List all API keys for the authenticated user. Never returns raw key values -- only prefixes and metadata.
curl "https://api.thepolarisreport.com/api/v1/keys" \ -H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"status": "ok",
"keys": [
{
"id": "...",
"key_prefix": "pr_live_aBcD",
"name": "production",
"created_at": "2026-03-09T10:00:00Z",
"last_used_at": "2026-03-09T11:30:00Z",
"calls_today": 142,
"calls_month": 2340
}
]
}Try It
Click Send Request to see response
/api/v1/webhooksCreate Webhook
Create a webhook subscription. Receive POST notifications when events occur. Supports raw JSON (HMAC-signed), Slack Block Kit, and Discord embed formats.
Request Body (JSON)
urlstringrequiredHTTPS URL to receive webhook POSTs
eventsstring[]requiredEvents: brief.published, brief.trending, brief.corrected
formatstringPayload format: raw (default), slack, or discord
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | HTTPS URL to receive webhook POSTs |
| events | string[] | Yes | Events: brief.published, brief.trending, brief.corrected |
| format | string | No | Payload format: raw (default), slack, or discord |
curl -X POST "https://api.thepolarisreport.com/api/v1/webhooks" \
-H "Authorization: Bearer YOUR_API_KEY"\
-H "Content-Type: application/json" \
-d '{}'Example Response
{
"status": "ok",
"webhook": {
"id": "...",
"url": "https://your-app.com/webhooks/polaris",
"events": ["brief.published"],
"secret": "whsec_aBcDeFgHiJkLmNoPqRsT..."
}
}Try It
Click Send Request to see response
// Error Reference
All errors return a JSON body with a message field and HTTP status code.
| Code | Meaning | Common Causes | Fix |
|---|---|---|---|
| 400 | Bad Request | Missing required params, invalid JSON | Check parameters and body format |
| 401 | Unauthorized | Missing or invalid API key / JWT | Verify your API key is correct |
| 402 | Payment Required | MPP-gated endpoint, no payment | Follow the 402 payment challenge or use a plan key |
| 403 | Forbidden | Key lacks endpoint/category access | Check key scopes in developer portal |
| 404 | Not Found | Invalid endpoint path or resource ID | Verify the URL and resource exist |
| 429 | Too Many Requests | Rate or spending limit exceeded | Back off; check RateLimit-* headers |
| 500 | Internal Error | Server-side issue | Retry after a short delay |
{
"status": "error",
"message": "Descriptive error message",
"code": 429
}SDKs Available
Python, TypeScript, LangChain, Vercel AI, CrewAI, and MCP. Install with one command.