BLbluestaq
State Vector

GET /udl/statevector

Changed on

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.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/statevector
  • Auth
    none declared

Query parameters

epochstring date-time required

Time of validity for state vector in ISO 8601 UTC datetime format, with microsecond precision. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

firstResultinteger
maxResultsinteger

Response

OK

idStateVectorstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

epochstring date-time required

Time of validity for state vector in ISO 8601 UTC datetime format, with microsecond precision.

pedigreestring

The pedigree of state vector, or methods used for its generation to include state update/orbit determination, propagation from another state, or a state from a calibration satellite (e.g. ORBIT_UPDATE, PROPAGATION, CALIBRATION, CONJUNCTION, FLIGHT_PLAN).

idOnOrbitstring

Unique identifier of the satellite on-orbit object, if correlated. For the public catalog, the idOnOrbit is typically the satellite number as a string, but may be a UUID for analyst or other unknown or untracked satellites.

satNointeger

Satellite/Catalog number of the target OnOrbit object.

origObjectIdstring

Optional identifier provided by state vector source to indicate the target onorbit object of this state vector. This may be an internal identifier and not necessarily map to a valid satellite number.

idOrbitDeterminationstring

Unique identifier of the OD solution record that produced this state vector. This ID can be used to obtain additional information on an OrbitDetermination object using the 'get by ID' operation (e.g. /udl/orbitdetermination/{id}). For example, the OrbitDetermination with idOrbitDetermination = abc would be queries as /udl/orbitdetermination/abc.

msgTsstring date-time

Time when message was generated in ISO 8601 UTC format with microsecond precision.

uctboolean

Boolean indicating this state vector was unable to be correlated to a known object. This flag should only be set to true by data providers after an attempt to correlate to an OnOrbit object was made and failed. If unable to correlate, the 'origObjectId' field may be populated with an internal data provider specific identifier.

xposnumber double

Cartesian X position of the target, in kilometers, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

yposnumber double

Cartesian Y position of the target, in kilometers, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

zposnumber double

Cartesian Z position of the target, in kilometers, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

xvelnumber double

Cartesian X velocity of target, in kilometers/second, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

yvelnumber double

Cartesian Y velocity of target, in kilometers/second, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

zvelnumber double

Cartesian Z velocity of target, in kilometers/second, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

xaccelnumber double

Cartesian X acceleration of target, in kilometers/second^2, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

yaccelnumber double

Cartesian Y acceleration of target, in kilometers/second^2, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

zaccelnumber double

Cartesian Z acceleration of target, in kilometers/second^2, in the specified referenceFrame. If referenceFrame is null then J2K should be assumed.

referenceFrame'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF'

The reference frame of the cartesian orbital states. If the referenceFrame is null it is assumed to be J2000.

covnumber[]

Covariance matrix, in kilometer and second based units, in the specified covReferenceFrame. If the covReferenceFrame is null it is assumed to be J2000. The array values (1-21) 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 cov array should contain only the lower left triangle values from top left down to bottom right, in order.

If additional covariance terms are included for DRAG, SRP, and/or THRUST, the matrix can be extended with the following order of elements:

          x    y    z   x'   y'   z'  DRG  SRP  THR

DRG      22   23   24   25   26   27   28

SRP      29   30   31   32   33   34   35   36

THR      37   38   39   40   41   42   43   44   45
covReferenceFrame'J2000' | 'UVW' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'GCRF'

The reference frame of the covariance matrix elements. If the covReferenceFrame is null it is assumed to be J2000.

covMethodstring

The method used to generate the covariance during the orbit determination (OD) that produced the state vector, or whether an arbitrary, non-calculated default value was used (CALCULATED, DEFAULT).

eqCovnumber[]

The covariance matrix values represent the lower triangular half of the covariance matrix in terms of equinoctial elements. The size of the covariance matrix is dynamic. The values are outputted in order across each row, i.e.:

1   2   3   4   5

6   7   8   9  10

:   :   :   :   :

:   :   :   :   :

51  52  53  54  55

:   :   :   :   :

:   :   :   :   :

The ordering of values is as follows:

         Af   Ag    L    N   Chi  Psi   B   BDOT AGOM  T    C1   C2  ...

Af        1

Ag        2    3

L         4    5    6

N         7    8    9   10

Chi      11   12   13   14   15

Psi      16   17   18   19   20   21

B        22   23   24   25   26   27   28

BDOT     29   30   31   32   33   34   35   36

AGOM     37   38   39   40   41   42   43   44   45

T        46   47   48   49   50   51   52   53   54   55

C1       56   57   58   59   60   61   62   63   64   65   66

C2       67   68   69   70   71   72   73   74   75   76   77   78

:

:

where C1, C2, etc, are the "consider parameters" that may be added to the covariance matrix. The covariance matrix will be as large as the last element/model parameter needed. In other words, if the DC solved for all 6 elements plus AGOM, the covariance matrix will be 9x9 (and the rows for B and BDOT will be all zeros). If the covariance matrix is unavailable, the size will be set to 0x0, and no data will follow. The cov field should contain only the lower left triangle values from top left down to bottom right, in order.

xposAlt1number double

Cartesian X position of the target, in kilometers, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

yposAlt1number double

Cartesian Y position of the target, in kilometers, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

zposAlt1number double

Cartesian Z position of the target, in kilometers, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

xvelAlt1number double

Cartesian X velocity of the target, in kilometers/second, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

yvelAlt1number double

Cartesian Y velocity of the target, in kilometers/second, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

zvelAlt1number double

Cartesian Z velocity of the target, in kilometers/second, in the specified alt1ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

alt1ReferenceFramestring

The reference frame of the alternate1 (Alt1) cartesian orbital state.

xposAlt2number double

Cartesian X position of the target, in kilometers, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

yposAlt2number double

Cartesian Y position of the target, in kilometers, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

zposAlt2number double

Cartesian Z position of the target, in kilometers, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

xvelAlt2number double

Cartesian X velocity of the target, in kilometers/second, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

yvelAlt2number double

Cartesian Y velocity of the target, in kilometers/second, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

zvelAlt2number double

Cartesian Z velocity of the target, in kilometers/second, in the specified alt2ReferenceFrame. Alternate reference frames are optional and are intended to allow a data source to provide an equivalent vector in a different cartesian frame than the primary vector.

alt2ReferenceFramestring

The reference frame of the alternate2 (Alt2) cartesian orbital state.

posUncnumber double

One sigma position uncertainty, in kilometers.

velUncnumber double

One sigma velocity uncertainty, in kilometers/second.

massnumber double

The mass of the object, in kilograms.

areanumber double

The actual area of the object at it's largest cross-section, expressed in meters^2.

solarRadPressCoeffnumber double

Area-to-mass ratio coefficient for solar radiation pressure.

dragCoeffnumber double

Area-to-mass ratio coefficient for atmospheric ballistic drag (m2/kg).

dragAreanumber double

The effective area of the object exposed to atmospheric drag, expressed in meters^2.

revNointeger

Epoch revolution number.

geopotentialModelstring

Geopotential model used for this vector (e.g. EGM-96, WGS-84, WGS-72, JGM-2, or GEM-T3), including mm degree zonals, nn degree/order tesserals. E.g. EGM-96 24Z,24T.

dragModelstring

The Drag Model used for this vector (e.g. HARRIS-PRIESTER, JAC70, JBH09, MSIS90, NONE, etc.).

lunarSolarboolean

Boolean indicating use of lunar/solar perturbations for this vector.

solarRadPressboolean

Boolean indicating use of solar radiation pressure perturbations for this vector.

srpAreanumber double

The effective area of the object exposed to solar radiation pressure, expressed in meters^2.

solidEarthTidesboolean

Boolean indicating use of solid earth tide perturbations for this vector.

inTrackThrustboolean

Boolean indicating use of in-track thrust perturbations for this vector.

bDotnumber double

First derivative of drag/ballistic coefficient (m2/kg-s).

edrnumber double

Model parameter value for energy dissipation rate (EDR) (w/kg).

thrustAccelnumber double

Model parameter value for thrust acceleration (m/s2).

cmOffsetnumber double

Model parameter value for center of mass offset (m).

lastObStartstring date-time

The start of the time interval containing the time of the last accepted observation, in ISO 8601 UTC format with microsecond precision. For an exact observation time, the firstObTime and lastObTime are the same.

lastObEndstring date-time

The end of the time interval containing the time of the last accepted observation, in ISO 8601 UTC format with microsecond precision. For an exact observation time, the firstObTime and lastObTime are the same.

obsAvailableinteger

The number of observations available for the OD of the object.

obsUsedinteger

The number of observations accepted for the OD of the object.

tracksAvailinteger

The number of sensor tracks available for the OD of the object.

tracksUsedinteger

The number of sensor tracks accepted for the OD of the object.

recODSpannumber double

The recommended OD time span calculated for the object, expressed in days.

actualODSpannumber double

The actual time span used for the OD of the object, expressed in days.

residualsAccnumber double

The percentage of residuals accepted in the OD of the object.

solarFluxF10number double

F10 (10.7 cm) solar flux value.

solarFluxF10Avgnumber double

F10 (10.7 cm) solar flux 81-day average value.

solarFluxAPAvgnumber double

Average solar flux geomagnetic index.

taiUtcnumber double

TAI (Temps Atomique International) minus UTC (Universal Time Coordinates) offset in seconds.

ut1Utcnumber double

Universal Time-1 (UT1) minus UTC offset, in seconds.

ut1Ratenumber double

Rate of change of UT1 (milliseconds/day) - first derivative of ut1Utc.

polarMotionXnumber double

Polar Wander Motion X (arc seconds).

polarMotionYnumber double

Polar Wander Motion Y (arc seconds).

iau1980Termsinteger

Number of terms used in the IAU 1980 nutation model (4, 50, or 106).

leapSecondTimestring date-time

Time of the next leap second after epoch in ISO 8601 UTC time. If the next leap second is not known, the time of the previous leap second is used.

integratorModestring

Integrator Mode.

partialsstring

Type of partial derivatives used (ANALYTIC, FULL NUM, or FAST NUM).

stepModestring

Integrator step mode (AUTO, TIME, or S).

fixedStepboolean

Boolean indicating use of fixed step size for this vector.

stepSizeSelectionstring

Initial step size selection (AUTO or MANUAL).

stepSizenumber double

Initial integration step size (seconds).

errorControlnumber double

Integrator error control.

sigmaPosUVWnumber[]

Array containing the standard deviation of error in target object position, U, V and W direction respectively (km).

sigmaVelUVWnumber[]

Array containing the standard deviation of error in target object velocity, U, V and W direction respectively (km/sec).

rmsnumber double

The Weighted Root Mean Squared (RMS) of the differential correction on the target object that produced this vector. WRMS is a quality indicator of the state vector update, with a value of 1.00 being optimal. WRMS applies to Batch Least Squares (BLS) processes.

sourcestring required

Source of the data.

originstring

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.

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.

algorithmstring

Optional algorithm used to produce this record.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

descriptorstring

Optional source-provided and searchable metadata or descriptor of the data.

missionCenterstring

Mission center or organization performing this vector creation.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

Example response

[
  {
    "idStateVector": "STATEVECTOR-ID",
    "classificationMarking": "U",
    "epoch": "2018-01-01T16:00:00.123456Z",
    "pedigree": "CONJUNCTION",
    "idOnOrbit": "ONORBIT-ID",
    "satNo": 12,
    "origObjectId": "ORIGOBJECT-ID",
    "idOrbitDetermination": "026dd511-8ba5-47d3-9909-836149f87686",
    "msgTs": "2018-01-01T16:00:00.123456Z",
    "uct": true,
    "xpos": -1118.577381,
    "ypos": 3026.231084,
    "zpos": 6167.831808,
    "xvel": -4.25242784,
    "yvel": 5.291107434,
    "zvel": -3.356493869,
    "xaccel": -2.12621392,
    "yaccel": 2.645553717,
    "zaccel": -1.06310696,
    "referenceFrame": "J2000",
    "cov": [
      1.1,
      2.4,
      3.8,
      4.2,
      5.5,
      6
    ],
    "covReferenceFrame": "J2000",
    "covMethod": "CALCULATED",
    "eqCov": [
      1.1,
      2.2
    ],
    "xposAlt1": -1145.688502,
    "yposAlt1": 3020.729572,
    "zposAlt1": 6165.55187,
    "xvelAlt1": -4.270832252,
    "yvelAlt1": 5.27074276,
    "zvelAlt1": -3.365155181,
    "alt1ReferenceFrame": "TEME",
    "xposAlt2": -1456.915926,
    "yposAlt2": -2883.540406,
    "zposAlt2": 6165.55187,
    "xvelAlt2": -1.219814294,
    "yvelAlt2": -6.602080212,
    "zvelAlt2": -3.365155181,
    "alt2ReferenceFrame": "EFG/TDR",
    "posUnc": 0.333399744452,
    "velUnc": 0.000004,
    "mass": 164.5,
    "area": 5.065,
    "solarRadPressCoeff": 0.0244394,
    "dragCoeff": 0.0224391269775,
    "dragArea": 4.739,
    "revNo": 7205,
    "geopotentialModel": "EGM-96",
    "dragModel": "JAC70",
    "lunarSolar": true,
    "solarRadPress": true,
    "srpArea": 4.311,
    "solidEarthTides": true,
    "inTrackThrust": true,
    "bDot": 1.23,
    "edr": 1.23,
    "thrustAccel": 1.23,
    "cmOffset": 1.23,
    "lastObStart": "2022-11-09T11:20:21.247192Z",
    "lastObEnd": "2022-11-09T11:20:21.247192Z",
    "obsAvailable": 376,
    "obsUsed": 374,
    "tracksAvail": 163,
    "tracksUsed": 163,
    "recODSpan": 3.5,
    "actualODSpan": 3.5,
    "residualsAcc": 99.5,
    "solarFluxF10": 1.23,
    "solarFluxF10Avg": 1.23,
    "solarFluxAPAvg": 1.23,
    "taiUtc": 1.23,
    "ut1Utc": 1.23,
    "ut1Rate": 1.23,
    "polarMotionX": 1.23,
    "polarMotionY": 1.23,
    "iau1980Terms": 4,
    "leapSecondTime": "2021-01-01T01:01:01.123Z",
    "integratorMode": "integratorMode",
    "partials": "ANALYTIC",
    "stepMode": "AUTO",
    "fixedStep": true,
    "stepSizeSelection": "AUTO",
    "stepSize": 1.23,
    "errorControl": 1.23,
    "sigmaPosUVW": [
      1.23,
      4.56
    ],
    "sigmaVelUVW": [
      1.23,
      4.56
    ],
    "rms": 0.991,
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "algorithm": "SAMPLE_ALGORITHM",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "descriptor": "descriptor",
    "missionCenter": "Mission Center A",
    "transactionId": "transactionId",
    "origNetwork": "OPS1",
    "sourceDL": "AXE"
  }
]

Changes

  • bd17bc53681eRevision changes
    • info

      added the optional property / to the response with the status

  • 09bd422d5ac1Revision changes
    • warning

      added the new ECR/ECEF enum value to the / response property for the response status

Some revisions have not been checked yet.