NestEgress Service Documentation

The NestEgress Service provides a REST API for accessing satellite telemetry data, including sensor readings and time-series data frames. This service enables authorized applications to retrieve mission-critical data.

API Access

• Service URL: https://api.space-dots-ingest-stg.click
• Health Check: GET /health (no authentication required)
• Interactive API Documentation: Available at https://api.space-dots-ingest-stg.click/api-docs (Swagger UI)

Available Data Types

The API provides access to two primary data categories:

1. Sensor Data: Individual sensor measurements with associated metadata
2. Time-Series Data Frames: Comprehensive telemetry frames containing position, velocity, orientation, and sensor status information

Authentication

Most endpoints require client credentials authentication. To access protected endpoints, you will need:

• Client ID: Provided by your administrator
• Client Secret: Provided by your administrator

Contact your Space Dots administrator to obtain the necessary credentials.

Getting Started

1. Contact your administrator to request API access credentials
2. Verify service availability using the /health endpoint
3. Review the API documentation at /api-docs for detailed endpoint information
4. Begin with public endpoints to understand the data structure
5. Use your credentials to access protected data endpoints

Public Endpoints

The following endpoints are available without authentication:

• GET /health - Service health status
• POST /api/sensor-data/bulk - Bulk sensor data ingestion
• POST /api/sensor-data/clear - Clear all sensor data (administrative use only)
• GET /api/time-series-dataframe - Paginated time-series data frames
• GET /api/time-series-dataframe/:id - Individual time-series data frame by ID

Data Examples

Time-Series Data Frame Example

{
  "unixTimestampMs": 1704067200000,
  "datasetId": "mission-001",
  "frameNumber": 1,
  "positionEciXKm": 6871.0,
  "positionEciYKm": 0.0,
  "positionEciZKm": 0.0,
  "latitudeDeg": 0.0,
  "longitudeDeg": 0.0,
  "altitudeKm": 6871.0,
  "quaternionQ0": 1.0,
  "quaternionQ1": 0.0,
  "quaternionQ2": 0.0,
  "quaternionQ3": 0.0,
  "tmSystemStatusTemperature": 25.5
}

Sensor Data Example

{
  "id": 1,
  "sensorId": "temperature-sensor-001",
  "timestamp": 1704067200000,
  "value": 23.5,
  "unit": "C",
  "metadata": {
    "location": "payload-bay",
    "accuracy": 0.1
  }
}

Support

For access requests, credential issues, or API questions, contact your Space Dots administrator.

---

Documentation last updated: February 2025