API Documentation

Programmatic access to Impact Radar event-driven signal engine. Available for Pro and Team plans.

Interactive API Docs (Swagger UI)ReDoc Documentation Download OpenAPI Spec

Overview

The Impact Radar API provides programmatic access to market events, impact scoring, portfolio risk analysis, and real-time alerts.

Base URL:/api

Response Format:JSON

Authentication:X-API-Key header

OpenAPI Version:3.1.0

Getting Started

1. Get Your API Key

API keys are available for Pro and Team plans. Generate yours from your Account Settings.

2. Make Your First Request

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.impactradar.co/api/events/public

Authentication

All authenticated endpoints require an API key passed in the x-api-key header.

Example Request:

curl -H "x-api-key: rr_live_1234567890abcdef" \
  https://api.impactradar.co/api/events/search?ticker=AAPL

Security Note: Never expose your API keys in client-side code or public repositories. Use environment variables and keep keys secure.

Rate Limits

Plan	Monthly Quota	Burst Limit	Features
Free	N/A	-	No API access
Pro	10,000 calls/month	100 req/min	Events, scoring, portfolio (3 tickers)
Team	100,000 calls/month	500 req/min	All features, unlimited tickers

Key Endpoints

GET /api/events/public

Retrieve public event feed with optional filters. No authentication required.

Query Parameters:

ticker - Filter by ticker symbol (e.g., AAPL)

sector - Filter by sector

min_score - Minimum impact score (0-100)

from_date - Start date (ISO 8601)

to_date - End date (ISO 8601)

limit - Results per page (default: 100)

Example:

curl "https://api.impactradar.co/api/events/public?ticker=AAPL&min_score=70"

GET /api/events/searchPro/Team

Advanced event search with full filtering and historical data access. Requires API key.

Example:

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.impactradar.co/api/events/search?ticker=AAPL&category=earnings"

POST /api/portfolio/uploadPro/Team

Upload portfolio positions from CSV file. Pro plan limited to 3 tickers, Team unlimited.

CSV Format:

portfolio.csv

ticker,qty,avg_price,label
AAPL,100,150.50,Core Holdings
MSFT,50,300.00,Tech Growth
TSLA,25,200.00,High Risk

GET /api/portfolio/insightsPro/Team

Analyze portfolio exposure to upcoming events. Returns risk scores and expected dollar moves.

Example:

import requests

response = requests.get(
    "https://api.impactradar.co/api/portfolio/insights?window_days=14",
    headers={"x-api-key": "YOUR_API_KEY"}
)

insights = response.json()
for position in insights:
    print(f"{position['ticker']}: {position['upcoming_events_count']} events")
    print(f"  Expected 1-day move: ${position['exposure_1d']:.2f}")
    print(f"  Risk score: {position['total_risk_score']:.1f}/100")

GET /api/companies

Get list of tracked companies with event counts. Public endpoint.

Example:

curl "https://api.impactradar.co/api/companies?sector=Technology&limit=10"

Error Handling

All errors return a consistent JSON format with error code, message, and optional details.

Error Response Format:

{
  "error_code": "QUOTA_EXCEEDED",
  "message": "API quota exceeded. Upgrade your plan or wait for monthly reset.",
  "details": {
    "quota_limit": 10000,
    "quota_used": 10000,
    "reset_date": "2024-02-01T00:00:00Z"
  },
  "status_code": 402
}

Common Error Codes:

401

UNAUTHORIZED

Invalid or missing API key

402

QUOTA_EXCEEDED

Monthly API quota limit reached

429

RATE_LIMIT_EXCEEDED

Too many requests, slow down

Need Help?

Check out our interactive API documentation or contact support if you have questions.

Upgrade Your Plan Contact Support