API Documentation

RegRadar API Reference

Comprehensive API documentation for integrating RegRadar's regulatory monitoring and compliance intelligence into your applications.

🚀 Quick Start

Get up and running in minutes with our RESTful API. Access real-time SEC filings, FDA pipeline events, risk assessments, and AI-powered analytics with simple HTTP requests.

🚀 Quick Start Guide

Get started with RegRadar API in under 5 minutes. Follow these simple steps to integrate regulatory monitoring into your application.

1

Get Your API Key

Sign up for a free account and generate your API key from the dashboard.

# Your API key will look like this:
rr_live_1234567890abcdef1234567890abcdef
2

Make Your First Request

Test the connection with a simple health check request.

curl -H "X-API-Key: rr_live_your_key_here" \
     https://api.regradar.com/v1/health
3

Fetch SEC Filings

Retrieve recent SEC filings for any public company.

curl -H "X-API-Key: rr_live_your_key_here" \
     "https://api.regradar.com/v1/filings?ticker=AAPL&limit=5"
4

Set Up Real-time Alerts

Configure webhooks to receive instant notifications when new filings are published.

curl -X POST \
     -H "X-API-Key: rr_live_your_key_here" \
     -H "Content-Type: application/json" \
     -d '{"url":"https://your-app.com/webhook","events":["filing"]}' \
     https://api.regradar.com/v1/webhooks

✅ You're Ready!

You now have access to real-time regulatory data. Explore the sections below to learn about advanced features, analytics, and machine learning capabilities.

🔑 API Keys & Authentication

RegRadar uses API key authentication for secure access to regulatory data. All requests must include your API key in the request headers.

Getting Your API Key

1

Sign up for a RegRadar account at app.regradar.com

2

Navigate to Settings → API Keys in your dashboard

3

Click "Generate New Key" and copy your API key

Using Your API Key

Include your API key in the X-API-Key header with every request:

curl -H "X-API-Key: rr_live_your_key_here" \
     https://api.regradar.com/v1/health

API Key Format

# Live API Key (Production)
rr_live_1234567890abcdef1234567890abcdef

# Test API Key (Development)
rr_test_1234567890abcdef1234567890abcdef

Security Best Practices:

  • • Never expose API keys in client-side code or public repositories
  • • Use environment variables to store API keys
  • • Rotate keys regularly for enhanced security
  • • Use test keys for development and live keys for production

🌐 Base URL & Endpoints

All RegRadar API requests are made to our secure HTTPS endpoints. We provide both RESTful endpoints and real-time streaming capabilities.

Base URL

https://api.regradar.com/v1

All API endpoints are prefixed with this base URL

Core Endpoints

EndpointMethodDescriptionStatus
/healthGETService health check and statusLive
/filingsGETSEC filing data and documentsLive
/companiesGETCompany information and metadataLive
/analytics/trendsPOSTTrend analysis and insightsLive
/analytics/riskPOSTRisk assessment and scoringLive
/webhooksPOSTWebhook subscription managementLive

Response Format

All API responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... },
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 50,
    "has_more": true
  },
  "meta": {
    "request_id": "req_123456789",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

⚡ Rate Limits & Quotas

RegRadar implements rate limiting to ensure fair usage and system stability. Rate limits vary by endpoint and subscription plan.

Free Tier Limits

EndpointRate LimitWindow
Health Check1,000 requests1 minute
SEC Filings100 requests1 minute
Analytics50 requests1 minute
Webhooks10 requests1 minute

Rate Limit Headers

Every API response includes headers showing your current rate limit status:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200
X-RateLimit-Window: 60

💡 Need Higher Limits?

Upgrade to a paid plan for higher rate limits, priority support, and advanced features. Contact us at support@regradar.com for custom enterprise limits.

Base URL & Endpoints

Base URL

https://2a7w8wekyk.execute-api.us-east-1.amazonaws.com/prod

Available Endpoints

EndpointMethodDescriptionStatus
/healthGETService health checkActive
/filingsGETSEC filing dataActive
/analytics/trendsPOSTAnalytics trends analysisActive
/ml/inference/riskPOSTML risk assessmentActive
/webhooks/subscriptionsPOSTWebhook subscription managementActive

SEC Filings

Access SEC filing data including 10-K, 10-Q, 8-K, and other regulatory documents with real-time updates and AI-powered analysis.

Get SEC Filings

GET /filings
Authorization: X-API-Key your-api-key

Query Parameters:
- cik: Company CIK number
- form_type: Filing type (10-K, 10-Q, 8-K, etc.)
- start_date: Start date (YYYY-MM-DD)
- end_date: End date (YYYY-MM-DD)
- limit: Number of results (default: 50, max: 100)

Example Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "accession_id": "0001193125-24-000001",
      "cik": "0000320193",
      "ticker": "AAPL",
      "issuer_name": "Apple Inc.",
      "form_type": "10-K",
      "filed_at": "2024-01-15T10:30:00Z",
      "period_end": "2024-09-30",
      "file_size": 5242880,
      "meta": {
        "sections_parsed": true,
        "entities_extracted": true
      }
    }
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 50,
    "has_more": true
  }
}

FDA Pipeline

Monitor FDA pipeline events including drug approvals, clinical trials, and regulatory decisions with real-time updates.

FDA Events Data

FDA pipeline data is automatically ingested and processed. Access through the analytics endpoints or set up webhooks for real-time notifications.

Event Types

  • Drug Approvals
  • Clinical Trial Results
  • Regulatory Decisions
  • Safety Alerts
  • Labeling Changes

Analytics

Advanced analytics endpoints provide trend analysis, correlation detection, risk scoring, and anomaly detection for regulatory data.

Trends Analysis

POST /analytics/trends
Content-Type: application/json
X-API-Key: your-api-key

{
  "data_type": "sec_filings",
  "timeframe": "30d",
  "metrics": ["risk_score", "compliance_issues"],
  "filters": {
    "industry": "technology",
    "form_type": ["10-K", "10-Q"]
  }
}

Risk Assessment

POST /analytics/risk-scores
Content-Type: application/json
X-API-Key: your-api-key

{
  "company_cik": "0000320193",
  "assessment_period": "90d",
  "risk_factors": ["financial", "regulatory", "operational"]
}

Machine Learning Models

AI-powered machine learning models for risk assessment, anomaly detection, and predictive analytics on regulatory data.

Risk Inference

POST /ml/inference/risk
Content-Type: application/json
X-API-Key: your-api-key

{
  "filing_data": {
    "content": "filing text content...",
    "metadata": {
      "form_type": "10-K",
      "company_cik": "0000320193"
    }
  },
  "model_version": "latest"
}

Anomaly Detection

POST /ml/inference/anomaly
Content-Type: application/json
X-API-Key: your-api-key

{
  "data_series": [
    {"date": "2024-01-01", "value": 0.75},
    {"date": "2024-01-02", "value": 0.82},
    {"date": "2024-01-03", "value": 0.91}
  ],
  "threshold": 0.8
}

Webhooks

Set up webhooks to receive real-time notifications when new regulatory events occur or when data is updated.

Create Webhook Subscription

POST /webhooks/subscriptions
Content-Type: application/json
X-API-Key: your-api-key

{
  "target_url": "https://your-app.com/webhook",
  "events": ["sec_filing", "fda_event", "risk_alert"],
  "secret": "your-webhook-secret"
}

Webhook Events

  • sec_filing: New SEC filing detected
  • fda_event: New FDA pipeline event
  • risk_alert: Risk threshold exceeded
  • anomaly_detected: ML anomaly detected

Data Ingestion

Manually trigger data ingestion for SEC filings and FDA events. Data is automatically processed and stored in the database.

SEC Filings Ingestion

POST /ingest/sec/filings
Content-Type: application/json
X-API-Key: your-api-key

{
  "date_range": {
    "start": "2024-01-01",
    "end": "2024-01-31"
  },
  "form_types": ["10-K", "10-Q", "8-K"]
}

FDA Events Ingestion

POST /ingest/fda/events
Content-Type: application/json
X-API-Key: your-api-key

{
  "event_types": ["approval", "clinical_trial", "safety_alert"],
  "priority": "high"
}

Document Parsing

AI-powered document parsing for SEC filings with entity extraction, section identification, and content analysis.

Parse SEC Documents

POST /parse/sec/documents
Content-Type: application/json
X-API-Key: your-api-key

{
  "accession_id": "0001193125-24-000001",
  "parse_options": {
    "extract_entities": true,
    "identify_sections": true,
    "risk_analysis": true
  }
}

Parsing Features

  • Section identification (MD&A, Risk Factors, etc.)
  • Entity extraction (companies, people, amounts)
  • Risk factor analysis
  • Financial data extraction
  • Compliance issue detection

JavaScript/TypeScript SDK

Official JavaScript/TypeScript SDK for easy integration with RegRadar API.

Installation

npm install @regradar/api-sdk

Basic Usage

import { RegRadarAPI } from '@regradar/api-sdk';

const api = new RegRadarAPI('your-api-key');

// Get SEC filings
const filings = await api.getFilings({
  cik: '0000320193',
  form_type: '10-K',
  limit: 10
});

// Analytics
const trends = await api.analytics.getTrends({
  data_type: 'sec_filings',
  timeframe: '30d'
});

// ML Inference
const riskScore = await api.ml.inference.risk({
  filing_data: { content: '...' }
});

Python SDK

Official Python SDK for RegRadar API integration.

Installation

pip install regradar-api

Basic Usage

from regradar import RegRadarAPI

api = RegRadarAPI(api_key='your-api-key')

# Get SEC filings
filings = api.get_filings(
    cik='0000320193',
    form_type='10-K',
    limit=10
)

# Analytics
trends = api.analytics.get_trends(
    data_type='sec_filings',
    timeframe='30d'
)

# ML Inference
risk_score = api.ml.inference.risk(
    filing_data={'content': '...'}
)

cURL Examples

Complete cURL examples for all RegRadar API endpoints.

Health Check

curl -H "X-API-Key: your-api-key" \
     https://2a7w8wekyk.execute-api.us-east-1.amazonaws.com/prod/health

Get SEC Filings

curl -H "X-API-Key: your-api-key" \
     "https://2a7w8wekyk.execute-api.us-east-1.amazonaws.com/prod/filings?cik=0000320193&form_type=10-K&limit=10"

Analytics Trends

curl -X POST \
     -H "X-API-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{"data_type":"sec_filings","timeframe":"30d"}' \
     https://2a7w8wekyk.execute-api.us-east-1.amazonaws.com/prod/analytics/trends

ML Risk Inference

curl -X POST \
     -H "X-API-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{"filing_data":{"content":"..."}}' \
     https://2a7w8wekyk.execute-api.us-east-1.amazonaws.com/prod/ml/inference/risk