API Reference citra_client v#0.3.0

Elixir client for the Citra Space API.

Generated operations for OpenAPI tag access.

Generated operations for OpenAPI tag account.

Generated operations for OpenAPI tag alert_subscriptions.

Generated operations for OpenAPI tag alerts.

Generated operations for OpenAPI tag antennas.

Generated operations for OpenAPI tag auth.

Generated operations for OpenAPI tag caf-results.

Generated operations for OpenAPI tag chat.

Generated operations for OpenAPI tag citrascope-data.

Generated operations for OpenAPI tag collection-requests.

Generated operations for OpenAPI tag Edge.

Generated operations for OpenAPI tag elsets.

Generated operations for OpenAPI tag filters.

Compile-time entry point for the generated API client.

Generated operations for OpenAPI tag ground_stations.

Generated operations for OpenAPI tag images.

Generated operations for OpenAPI tag iq-data.

Generated operations for OpenAPI tag maneuvers.

Generated operations for OpenAPI tag metrics.

Generated operations for OpenAPI tag observations.

Generated operations for OpenAPI tag od.

Generated operations for OpenAPI tag rf_captures.

Generated operations for OpenAPI tag satellite-events.

Generated operations for OpenAPI tag satellite_groups.

Generated operations for OpenAPI tag satellites.

Struct generated from the AddUserToGroupRequest schema.

Complete alert schema for responses

Complete alert subscription schema for responses

Schema for alert subscription creation

Schema for alert subscription update operations

Full antenna schema with all fields

Schema for antenna creation - required fields enforced

Schema for antenna upsert operations (create or update)

Schema for batch creation of collection requests across multiple satellites.

Response schema for batch collection request creation.

A collection request extended with its aggregated CAF timeline data.

A single peak from a CAF computation.

Full CAF result record for a single antenna pair (no surface data).

CAF surface data for visualization (base64-encoded float32 arrays).

Aggregated summary for a single time bin across all antenna pairs.

Schema for reading chat feedback.

Schema for creating chat feedback.

CollectionRequest schema for reading

CollectionRequest schema for creation

Schema for reading a conversation.

Schema for creating a new conversation.

A coordinated observation window where multiple ground stations can observe a satellite.

Country option for filtering.

Current weather data

Daily feels like temperature data

Daily forecast data

Daily temperature data

Individual RF detection

Configuration for telescopes with discrete filter wheels.

Struct generated from the ElsetCountBin schema.

A single point in the elset history timeline.

Response containing historical elset data for a satellite.

Struct generated from the Elset-Input schema.

Struct generated from the Elset-Output schema.

A single ephemeris point with position in TEME inertial coordinates.

Request for satellite ephemeris data. Returns pre-computed TEME (True Equator Mean Equinox) inertial positions for accurate orbit visualization, supporting both SGP4 and SGP4-XP propagation. Use Cesium ReferenceFrame.INERTIAL to display true orbital shapes (circles/ellipses).

Response model for FITS image data formatted for Plotly heatmap

Struct generated from the FOVAccessPost schema.

Response containing list of expanded filters.

Request schema for filter expansion.

Response schema for filter expansion with wavelength information.

Basic filter information for UI.

Response containing available standard filters grouped by system.

Distinct values for satellite text-field filters.

Specification for a single discrete filter.

A frequency range defined by min and max values in MHz.

Struct generated from the GEOSatellitePlotData schema.

Struct generated from the GPSJammingResponse schema.

Optional request model for calculating residuals with custom parameters

Struct generated from the GlobeSatellite schema.

Struct generated from the GroundStation schema.

Struct generated from the GroundStationCreate schema.

Struct generated from the GroundStationInput schema.

Struct generated from the GroundStationList schema.

A single point in a satellite's ground track.

Ground track data for a satellite over a time period.

Struct generated from the HTTPValidationError schema.

A single ground station's access window to a satellite.

Struct generated from the HorizonState schema.

Hourly forecast data

Configuration for hyperspectral instruments and spectrographs.

Full IQ upload record schema.

Request body for initiating an IQ upload.

Response from initiating an IQ upload - contains presigned URL.

Response for listing IQ uploads.

Struct generated from the LeoElsetPoint schema.

Complete maneuver schema for responses

Schema for maneuver creation

Schema for maneuver update operations

Schema for reading a message.

Schema for creating a new message in a conversation.

Minute forecast data

Struct generated from the MsiBusPredictionRead schema.

Struct generated from the MsiBusPredictionReadList schema.

Struct generated from the MyUploadUsageResponse schema.

Struct generated from the NearGeoElsetPoint schema.

Response schema for observation time bounds for a satellite.

Struct generated from the ObservationResidual schema.

Struct generated from the OpticalObservationCountBin schema.

Schema for creating optical observations - excludes auto-generated fields

A single point in the optical observation history.

Response containing historical optical observation data.

A single point in orbital elements history.

Response containing orbital elements history for plotting.

Struct generated from the PaginatedResponse_Alert_ schema.

Struct generated from the PaginatedResponse_SatelliteSummary_ schema.

personal access token (without the actual token or hash)

schema for creating a new personal access token

schema for the response when a token is created (includes the actual token)

schema for a list of personal access tokens

Power spectral density data

Simple provider (user group) info for alert subscription filtering

Struct generated from the ProviderContributionRow schema.

Request schema for creating a new RF capture

Complete RF capture data structure

Response schema for RF capture with full data

Response schema for RF capture without data field (for list endpoints)

Circle region overlay

Polygon region overlay

Struct generated from the RelativePlotData schema.

Struct generated from the Satellite schema.

Struct generated from the SatelliteAlias schema.

Ephemeris data for a single satellite.

Struct generated from the SatelliteEventRead schema.

Complete satellite group schema for responses

Schema for adding satellites to a group

Schema for satellite group creation - required fields enforced

Schema for removing satellites from a group

Schema for satellite group upsert operations (create or update)

Struct generated from the SatelliteInFOV schema.

Struct generated from the SatelliteOriginEventRead schema.

Struct generated from the SatelliteOverview schema.

Struct generated from the SatellitePage schema.

Struct generated from the SatelliteSummary schema.

Struct generated from the SatelliteTransmissionRead schema.

Response schema for a signed CloudFront URL.

Fields used when making a request for access window calculations from ground stations to a satellite

Fields used when making a request for access window calculations from satellites to ground station(s). Pass 1 ID for single-station access, or 2+ IDs for coordinated/TDOA access (overlapping windows only).

Fields used when making a request for access window calculations from satellites to geographic locations (waypoints)

Struct generated from the SolveOD schema.

Task schema for reading

Task schema for creation

Task schema for updates

Struct generated from the Telescope schema.

Schema for telescope creation - required fields enforced.

Schema for telescope update operations (PATCH) - all fields optional

Schema for telescope upsert operations (create or update)

Configuration for tunable filters (LCTF, AOTF).

Response schema for unread alert count

Struct generated from the UploadInitiateResponse schema.

Struct generated from the UploadListItemResponse schema.

Struct generated from the UploadStatusResponse schema.

Struct generated from the UserGroupRead schema.

Struct generated from the UserInterfacePreferences schema.

Partial update schema for interface preferences - all fields optional.

Struct generated from the UserPreferences schema.

Partial update schema for user preferences - supports partial nested updates.

Struct generated from the UserRead schema.

Struct generated from the ValidationError schema.

A geographic location with a time range for access calculations.

Weather alert data

Basic weather condition info from OpenWeatherMap API

Complete weather response from OpenWeatherMap One Call API 3.0

Generated operations for OpenAPI tag stats.

Generated operations for OpenAPI tag tasks.

Generated operations for OpenAPI tag telescopes.

Generated operations for OpenAPI tag weather.