API Reference

Detailed technical specifications and implementation examples for our orbital calculation API.

Core API Features

• RESTful API design with JSON payload handling

• HTTPS/TLS-1.2+ encryption for all endpoints

• Rate limiting and authentication headers

• OAuth2.0 and API key authentication

• Comprehensive error codes and system diagnostics

• Real-time response validation

API Endpoints Overview

Core Endpoints

  • POST /v3/orbits/calculate
  • GET /v3/satellites/[:id]
  • PATCH /v3/missions/[:id]
  • GET /v3/health

All endpoints require "Content-Type: application/json" and proper authentication

Authentication

API Key: bearer <your-api-key>
OAuth2.0: access_token<JWT>
Authorization: Bearer <token>

Usage Examples

Create Orbit Calculation

POST /v3/orbits/calculate
Content-Type: application/json
Authorization: Bearer <token>

{
  "satelliteId": "SAT-098765",
  "startTime": "2025-08-28T12:00:00Z",
  "endTime": "2025-08-28t13:00:00Z"
}

Sample Response

{
  "status": "success",
  "data": {
    "orbitPaths": [...],
    "altitudeProfile": "328km - 412km",
    "duration": "60 minutes"
  }
}

Rate Limiting Policy

Free Tier

  • 500 requests/hour
  • HTTP 429 when rate limit reached
  • Header: X-RateLimit-Remaining

Enterprise Tier

  • Unmetered requests
  • Private IP whitelisting
  • Dedicated API endpoint

Common Error Codes

Status Code Description Solution
401 Unauthorized Missing or invalid auth token Ensure API key is set in Authorization header
429 Too Many Requests Rate limit exceeded Review X-RateLimit-Remaining header for reset
503 Service Unavailable Temporary maintenance Retry after 5-10 minutes with exponential backoff

Found a Bug or Want More Documentation?

Report technical issues or suggest documentation improvements.

Contact Documentation Team