API & Data Access

Why Use Our API?

Authentication & Rate Limits

curl -H "X-API-Key: your_api_key_here" \
  https://orbitaldb.orbital-law.co/v1/portal/risk-bulletin/high-energy-conjunctions?days=14

Complete API Reference (88 Endpoints)

🔓 Public Analytics Endpoints (Free/Pro Tiers)

📊 CSV Export Endpoints (3)

🔒 Authenticated Endpoints (Require API Authentication)

Space Objects & Search (4 endpoints)

• • GET /v1/objects - List all space objects with filtering
• • GET /v1/objects/{satcat} - Get specific satellite by SATCAT number
• • GET /v1/search - Search satellites by name, COSPAR, or SATCAT
• • GET /health - API health check & data freshness

Operators & Constellations (11 endpoints)

• • GET /v1/operators - List all satellite operators
• • GET /v1/operators/{id} - Get operator details
• • GET /v1/operators/{id}/satellites - List operator's satellites
• • GET /v1/operators/{id}/risk-profile - Operator risk assessment
• • GET /v1/constellations - List all constellations
• • GET /v1/constellations/{id} - Get constellation details
• • GET /v1/constellations/{id}/satellites - Constellation members
• • GET /v1/constellations/{id}/members - Alias for satellites
• • GET /v1/constellations/{id}/health - Constellation health metrics
• • GET /v1/constellations/{id}/coverage - Coverage analysis
• • GET /v1/constellations/{id}/conflicts - Constellation conflicts

Machine Learning Predictions (4 endpoints)

• • GET /v1/ml/predict/risk/{satcat} - ML risk score for satellite
• • POST /v1/ml/predict/batch - Batch risk predictions (up to 50)
• • GET /v1/ml/high-risk-satellites - Top high-risk satellites
• • GET /v1/ml/model-info - Model version & performance metrics

Conjunctions & Threats (3 endpoints)

• • GET /v1/conjunctions - List all conjunction events
• • GET /v1/conjunctions/{cdm_id} - Get CDM details
• • GET /v1/conjunctions/threats/{satcat} - Threats for specific satellite

Compliance & Regulatory (3 endpoints)

• • GET /v1/compliance/debris-mitigation - 25-year rule compliance
• • GET /v1/compliance/registration - UN registration status
• • GET /v1/compliance/regulatory/{satcat} - Compliance report for satellite

Risk Analysis (2 endpoints)

• • GET /v1/analysis/insurance-risk/{satcat} - Insurance risk profile
• • POST /v1/analysis/constellation-conflict - Constellation deconfliction

Debris Analysis (8 endpoints)

• • GET /v1/debris/adr-targets - Active Debris Removal targets
• • GET /v1/debris/collision-priority - Collision avoidance priority
• • GET /v1/debris/repeat-offenders - Repeat conjunction offenders
• • GET /v1/debris/launch-window - Launch window analysis
• • GET /v1/debris/constellation-deconfliction - Mega-constellation conflicts
• • GET /v1/debris/maneuver-optimize - Maneuver cost optimization
• • GET /v1/debris/removal-impact/{satcat} - ADR economic impact
• • POST /v1/debris/removal-impact-batch - Batch ADR impact (up to 50)

Maneuver Simulation (3 endpoints)

• • POST /v1/maneuvers/simulate/conjunction-avoidance/{satcat} - Simulate CAM
• • POST /v1/maneuvers/simulate/custom/{satcat} - Custom Delta-V simulation
• • POST /v1/maneuvers/cost-estimate - Fuel cost estimation

Batch Operations (3 endpoints)

• • POST /v1/batch/conjunction-threats - Batch threat analysis (up to 50)
• • POST /v1/batch/compliance-check - Batch compliance check (up to 50)
• • POST /v1/batch/satellite-info - Batch satellite info (up to 50)

Satellite Capabilities (3 endpoints)

• • GET /v1/capabilities - List all satellite capabilities
• • GET /v1/capabilities/{satcat} - Satellite maneuver capabilities
• • GET /v1/capabilities/summary - Capabilities summary statistics

Analytics & Reporting (4 endpoints)

• • GET /v1/analytics/satellite-age-distribution - Age distribution (6 brackets)
• • GET /v1/analytics/operator-scorecard - Operator grades (A-F)
• • GET /v1/analytics/conjunction-heatmap - Conjunction density map
• • GET /v1/analytics/treaty-violations - UN treaty violations

System & Administration (9 endpoints)

• • GET /v1/system/status - System status & metrics
• • GET /v1/system/data-freshness - Data source freshness
• • POST /v1/system/refresh - Trigger data refresh (admin)
• • POST /v1/analytics/track - Track page view
• • GET /v1/analytics/summary - Analytics summary
• • GET /v1/admin/audit-logs - Audit log query (admin)
• • GET /v1/admin/audit-stats - Audit statistics (admin)
• • POST /v1/admin/audit-cleanup - Cleanup old logs (admin)
• • POST /admin/trigger-update - Trigger DB update (admin)

Authentication & API Keys (10 endpoints)

• • POST /v1/auth/register - Create user account
• • POST /v1/auth/login - User login
• • POST /v1/auth/logout - User logout
• • POST /v1/auth/refresh - Refresh JWT token
• • POST /v1/auth/verify-email - Verify email address
• • POST /v1/auth/reset-password-request - Request password reset
• • POST /v1/auth/reset-password - Reset password
• • GET /v1/auth/me - Get current user info
• • GET /v1/api-keys - List user's API keys
• • POST /v1/api-keys - Generate new API key
• • DELETE /v1/api-keys/{key_id} - Revoke API key

Alerts & Notifications (5 endpoints)

• • GET /v1/alerts/config - List alert configurations
• • POST /v1/alerts/config - Create alert configuration
• • PUT /v1/alerts/config/{config_id} - Update alert config
• • DELETE /v1/alerts/config/{config_id} - Delete alert config
• • GET /v1/alerts/history - Alert notification history
• • POST /v1/alerts/run-check - Manually trigger alert check

Feedback & Subscriptions (3 endpoints)

• • POST /v1/feedback - Submit user feedback
• • POST /v1/newsletter/subscribe - Subscribe to newsletter
• • POST /v1/api-access/request - Request API access

API Documentation (2 endpoints)

• • GET /docs - Interactive API documentation (Swagger UI)
• • GET /openapi.yaml - OpenAPI 3.0 specification

Example Requests

import requests

API_URL = "https://orbitaldb.orbital-law.co"
API_KEY = "your_api_key_here"
headers = {"X-API-Key": API_KEY}

# Get high-energy conjunctions
response = requests.get(
    f"https://orbitaldb.orbital-law.co/v1/portal/risk-bulletin/high-energy-conjunctions",
    headers=headers,
    params={"days": 14, "limit": 20}
)
data = response.json()

print(f"Found {len(data['conjunctions'])} high-energy events")
for conj in data['conjunctions'][:5]:
    print(f"{conj['sat1_name']} vs {conj['sat2_name']}: {conj['collision_energy_gj']:.1f} GJ")

const API_URL = "https://orbitaldb.orbital-law.co";
const API_KEY = "your_api_key_here";

const response = await fetch(
  `${API_URL}/v1/portal/compliance-tracker/leaderboard?min_satellites=10&limit=50`,
  { headers: { "X-API-Key": API_KEY } }
);

const data = await response.json();
console.log(`Global compliance rate: ${data.summary.global_compliance_rate}%`);
console.log(`Total active satellites: ${data.summary.total_active}`);

# Get repeat offenders
curl -H "X-API-Key: your_api_key_here" \
  "https://orbitaldb.orbital-law.co/v1/portal/risk-bulletin/repeat-offenders?min_events=5&limit=20"

# Download CSV
curl -H "X-API-Key: your_api_key_here" \
  "https://orbitaldb.orbital-law.co/v1/downloads/high-energy-conjunctions.csv?days=14&limit=100" \
  -o conjunctions.csv