---
title: "GET /udl/ephemeris"
method: GET
path: "/udl/ephemeris"
tags: ["Ephemeris"]
---

# GET /udl/ephemeris

`GET /udl/ephemeris`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/udl/ephemeris`
- Auth: none declared

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl/<datatype>/queryhelp`) for more details on valid/required query parameter information.

## Query parameters

- `esId` string, required
- `firstResult` integer
- `maxResults` integer

## Response `200`

OK

- EphemerisAbridged[]
  - `id` string: Unique identifier of the record, auto-generated by the system.
  - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
  - `esId` string: Unique identifier of the parent EphemerisSet, auto-generated by the system. The esId (ephemerisSet id) is used to identify all individual ephemeris states associated with a parent ephemerisSet.
  - `ts` string, date-time, required: Time associated with the Ephemeris Point, in ISO8601 UTC format.
  - `xpos` number, double, required: Cartesian X position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `ypos` number, double, required: Cartesian Y position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `zpos` number, double, required: Cartesian Z position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `xvel` number, double, required: Cartesian X velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `yvel` number, double, required: Cartesian Y velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `zvel` number, double, required: Cartesian Z velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `xaccel` number, double: Cartesian X acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `yaccel` number, double: Cartesian Y acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `zaccel` number, double: Cartesian Z acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.
  - `cov` number[]: Covariance matrix, in kilometer and second based units, in the specified Ephemeris Set covReferenceFrame. If the covReferenceFrame from the EphemerisSet table is null it is assumed to be J2000. The array values represent the lower triangular half of the position-velocity covariance matrix. The size of the covariance matrix is dynamic, depending on whether the covariance for position only or position & velocity. The covariance elements are position dependent within the array with values ordered as follows: ``` x y z x' y' z' x 1 y 2 3 z 4 5 6 x' 7 8 9 10 y' 11 12 13 14 15 z' 16 17 18 19 20 21 ``` The array containing the covariance matrix elements will be of length 6 for position only covariance, or length 21 for position-velocity covariance. The cov array should contain only the lower left triangle values from top left down to bottom right, in order.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
  - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
  - `source` string, required: Source of the data.
  - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.
  - `idOnOrbit` string: Unique identifier of the on-orbit satellite object.
  - `origObjectId` string: Optional identifier provided by ephemeris source to indicate the target object of this ephemeris. This may be an internal identifier and not necessarily map to a valid satellite number.
  - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `405`: Method Not Allowed
- `406`: MediaType Not Accepted by Request Headers
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-05-29** `4e1cbc17e814`: 2 info
  - added the new optional `query` request parameter `firstResult`
  - added the new optional `query` request parameter `maxResults`
- **2025-04-16** `75f764c843a9`: 2 info
  - api operation id `findAllWithStream_9` removed and replaced with ``
  - the endpoint scheme security `BasicAuth` was removed from the API

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/ephemeris/get.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)
