CitraClient.Satellites (citra_client v0.3.0)
View SourceGenerated operations for OpenAPI tag satellites.
Summary
Functions
Create Elset
Get Close Approaches
Get Country Options
Get Filter Options
Get Globe Satellites
Get Observation Bounds
Get Overview
Get Relative Data
Get Residuals
Get Satellite
Get Satellite Collection Requests
Get Satellite Elset History
Get Satellite Elsets
Get Satellite Ground Track
Get Satellite Orbital Elements
Get Satellite Page
Get Satellite Tasks
Get Satellites
Functions
Create Elset
Create a new elset for a satellite
POST /satellites/{satellite_id}/elsets
Path parameters
satellite_id(path)
Body
Request body (map or generated struct).
Get Close Approaches
Get close approaches for a specific satellite
GET /satellites/{satellite_id}/close-approaches
Path parameters
satellite_id(path)
Options (passed via keyword list)
:hours— Number of hours ahead to check for close approaches:min_distance— Minimum distance for close approaches
Get Country Options
Get list of all available countries for filtering.
GET /satellites/countries
Get Filter Options
Get distinct values for satellite text-field filters.
GET /satellites/filter-options
Get Globe Satellites
GET /satellites/globe
Get Observation Bounds
Get the earliest and latest observation epochs for a satellite.
Returns the time bounds and count of all approved optical observations for this satellite that the user has access to.
GET /satellites/{satellite_id}/observation-bounds
Path parameters
satellite_id(path)
Get Overview
Get overview counts for active/decayed satellites, antennas, and telescopes.
GET /satellites/overview
Get Relative Data
GET /satellites/{satellite_id}/relative/{other_sat_id}
Path parameters
satellite_id(path)other_sat_id(path)
Options (passed via keyword list)
:step— Step size to use when calculating relative state:hours— Number of hours to propagate the relative state:start— Start time for relative state propagation
Get Residuals
Get residuals for a specific satellite.
If no elset is provided, uses the latest elset from the database. Uses observation_start and observation_end from request, defaulting to last 5 days if not provided. Returns an empty list if no elset is available (cannot compute residuals without an elset).
POST /satellites/{satellite_id}/residuals
Path parameters
satellite_id(path)
Body
Request body (map or generated struct).
Get Satellite
GET /satellites/{satellite_id}
Path parameters
satellite_id(path)
Get Satellite Collection Requests
Get all collection requests for a specific satellite with their associated tasks
GET /satellites/{satellite_id}/collection-requests
Path parameters
satellite_id(path)
Options (passed via keyword list)
:window_start_after— Filter requests with window starting after this time (ISO 8601 format):window_start_before— Filter requests with window starting before this time (ISO 8601 format):window_stop_after— Filter requests with window stopping after this time (ISO 8601 format):window_stop_before— Filter requests with window stopping before this time (ISO 8601 format):statuses— Filter requests by status (can provide multiple statuses)
Get Satellite Elset History
Get historical elset data for a satellite over a time range.
By default, returns only hot/recent data. Set includeArchive=true to also query archived cold data from Athena. Results are sorted by epoch in ascending order.
For long-running queries, the API may return a 202 status with a queryId. Retry the request with the same queryId to check status and retrieve results.
Datetime format: ISO 8601 (e.g., 2024-01-15T12:00:00Z)
GET /satellites/{satellite_id}/elset-history
Path parameters
satellite_id(path)
Options (passed via keyword list)
:start_after— Return elsets after this time (ISO 8601 format). Defaults to 1950-01-01.:end_before— Return elsets before this time (ISO 8601 format). Defaults to now.:query_id— Query execution ID from a previous request (for async retrieval):include_archive— If true, also query archived (cold) data from Athena. Defaults to false, returning only hot/recent data.
Get Satellite Elsets
Get elsets for a satellite, ordered by XP priority then recency.
Uses XP elset priority logic: prefers XP elsets within 24 hours of the latest elset. Use ?limit=1 to get the single best elset for the satellite.
GET /satellites/{satellite_id}/elsets
Path parameters
satellite_id(path)
Options (passed via keyword list)
:limit— Limit number of results (use 1 to get best elset):types— Filter to specific elset types. Omit for server-default ranking.
Get Satellite Ground Track
Get ground track data for a satellite over a specified time period.
Returns latitude/longitude positions for plotting the satellite's path on a map. The ground track shows where the satellite passes over the Earth's surface.
If hours and step_minutes are not provided, smart defaults are calculated based on orbit type:
- True GEO (inclination < 1°, stable): Returns 1 point (satellite barely moves)
- Inclined GEO (figure-8 pattern): 24 hours at 10-minute intervals
- LEO/MEO: 1 orbital period at 1-minute intervals
GET /satellites/{satellite_id}/ground-track
Path parameters
satellite_id(path)
Options (passed via keyword list)
:hours— Hours of ground track (optional - auto-calculated based on orbit type):step_minutes— Time step in minutes (optional - auto-calculated based on orbit type)
Get Satellite Orbital Elements
Get orbital elements history with calculated period and altitudes.
Returns time-series data optimized for orbital element plots.
GET /satellites/{satellite_id}/orbital-elements
Path parameters
satellite_id(path)
Options (passed via keyword list)
:start_after— Return data after this time (ISO 8601 format):end_before— Return data before this time (ISO 8601 format)
Get Satellite Page
GET /satellites/page
Options (passed via keyword list)
:offset(required):limit(required):show_all_review_statuses
Get Satellite Tasks
Get all tasks for a specific satellite, optionally filtered by a set of parameters
GET /satellites/{satellite_id}/tasks
Path parameters
satellite_id(path)
Options (passed via keyword list)
:task_start_after— Filter tasks starting after this time (ISO 8601 format):task_start_before— Filter tasks starting before this time (ISO 8601 format):task_stop_after— Filter tasks stopping after this time (ISO 8601 format):task_stop_before— Filter tasks stopping before this time (ISO 8601 format):statuses— Filter tasks by status (can provide multiple statuses)
Get Satellites
Get satellites with server-side pagination, sorting, and filtering.
GET /satellites
Options (passed via keyword list)
:page:page_size:sort— JSON array of sort items:filters— JSON array of filter items:filter_logic— Filter logic operator (and/or):quick_filter:show_decayed:show_all_review_statuses