BLbluestaq
Track

GET /udl/orbittrack

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/orbittrack
  • Auth
    none declared

Query parameters

tsstring date-time required

Track timestamp in ISO8601 UTC format, with microsecond precision. (YYYY-MM-DDTHH:MM:SS.ssssssZ)

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system if not provided on create operations.

classificationMarkingstring required

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

idOnOrbitstring

Unique identifier of the target on-orbit object, if correlated.

satNointeger

Satellite/catalog number of the target on-orbit object.

origObjectIdstring

Optional identifier provided by observation source to indicate the target on-orbit object of this track. This may be an internal identifier and not necessarily a valid satellite number.

idElsetstring

Unique identifier of the Elset associated with this object.

tsstring date-time required

Track timestamp in ISO8601 UTC format, with microsecond precision.

latnumber double required

WGS-84 latitude of the track object subpoint, in degrees. -90 to 90 degrees (negative values south of equator).

lonnumber double required

WGS-84 longitude of the track object subpoint, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

altnumber double

Track point altitude relative to WGS-84 ellipsoid, in meters.

rdfRFnumber double

Radio frequency of the track, measured in megahertz (MHz).

callSignstring

International radio call sign assigned to the track. This is an 8-character alphanumeric code.

rptNumstring

Report number received from the reporting source for this track.

objIdent'ASSUMED FRIEND' | 'FRIEND' | 'HOSTILE' | 'NEUTRAL' | 'PENDING' | 'SUSPECT' | 'UNKNOWN'

The estimated identity of the track object (ASSUMED FRIEND, FRIEND, HOSTILE, NEUTRAL, PENDING, SUSPECT, UNKNOWN):

ASSUMED FRIEND: Track assumed to be a friend due to the object characteristics, behavior, and/or origin.

FRIEND: Track object supporting friendly forces and belonging to a declared friendly nation or entity.

HOSTILE: Track object belonging to an opposing nation, party, group, or entity deemed to contribute to a threat to friendly forces or their mission due to its behavior, characteristics, nationality, or origin.

NEUTRAL: Track object whose characteristics, behavior, nationality, and/or origin indicate that it is neither supporting nor opposing friendly forces or their mission.

PENDING: Track object which has not been evaluated.

SUSPECT: Track object deemed potentially hostile due to the object characteristics, behavior, nationality, and/or origin.

UNKNOWN: Track object which has been evaluated and does not meet criteria for any standard identity.

identAmpstring

Additional track object identity/status information, typically used for EXERCISE identity amplification (FAKER, JOKER, KILO, TRAVELLER, ZOMBIE):

FAKER: Friendly track, object, or entity acting as an exercise hostile.

JOKER: Friendly track, object, or entity acting as an exercise suspect.

KILO: Friendly high-value object.

TRAVELLER: Suspect land or surface track following a recognized traffic route.

ZOMBIE: Suspect track, object, or entity of special interest.

satStatusstring

Status of the satellite.

objectType'DEBRIS' | 'MANNED' | 'PAYLOAD' | 'PLATFORM' | 'ROCKET BODY' | 'UNKNOWN'

The on-orbit category assigned to this track object (DEBRIS, MANNED, PAYLOAD, PLATFORM, ROCKET BODY, UNKNOWN).

countryCodestring

The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

decaynumber double

Predicted change in Mean Motion (velocity) in radians/herg^2. herg is a unit of time measure equal to 806.8120769 seconds, and is the orbital period of an imaginary satellite rotating about the Earth at zero altitude.

charlieLinestring

One-line Charlie elements set.

aouTypestring

The Area of Uncertainty (AoU) type (BEARING, ELLIPSE, OTHER) definition. This type defines the elements of the aouData array and is required if aouData is not null. See the aouData field definition for specific information.

aouDatanumber[]

Three element array representing an Area of Uncertainty (AoU). The array element definitions and units are type specific depending on the aouType specified in this record:

ELLIPSE:

brg - orientation in degrees of the ellipse

a1 - semi-major axis in meters

a2 - semi-minor axis in meters

BEARING (BEARING BOX or MTST BEARING BOX):

brg - orientation in degrees of the bearing box

a1 - length of bearing box in meters

a2 - half-width of bearing box in meters

OTHER (All other type values):

brg - line of bearing in degrees true

a1 - bearing error in degrees

a2 - estimated range in meters.

spdnumber double

Track object speed, in km/sec.

angElevnumber double

The angle formed between the line of sight of the observer and the horizon at track timestamp, in degrees. The angular range is -90 to 90, with negative values representing angle of depression.

cntnmntnumber double

The Area Of Uncertainty (AOU) percentage (0 - 100) containment value. The percentage of time (90%) that the estimated area of uncertainty will cover the true position of the track object.

xrefstring

Source cross-reference code for the command that originated the track report.

chXRefstring

The cross-reference code of the channel on which this track report was received, if the report came over a comms channel.

amplificationstring

Free-form remarks entered for the satellite.

iffstring

A text amplifier displaying IFF/SIF/AIS Identification modes and codes.

reinforcedboolean

Flag indicating that this track represents a reinforced object or group. Based on MIL-STD-2525 symbology definitions.

reducedboolean

Flag indicating that this track represents a reduced object or group. Based on MIL-STD-2525 symbology definitions.

hqboolean

Flag indicating that this track represents a headquarters object. Based on MIL-STD-2525 symbology definitions.

dummyboolean

Flag indicating that this track represents a dummy object or group. Identifies offensive or defensive units, equipment and/or installations intended to draw the enemy's attention away from the area of the main attack. Based on MIL-STD-2525 symbology definitions.

taskForceboolean

Flag indicating that this track represents a task force. Based on MIL-STD-2525 symbology definitions.

feintboolean

Flag indicating that this track represents a feint object or group. Identifies offensive or defensive units, equipment and/or installations intended to draw the enemy's attention away from the area of the main attack. Based on MIL-STD-2525 symbology definitions.

installationboolean

Flag indicating that this track represents an installation. Based on MIL-STD-2525 symbology definitions.

vehTypestring

The type of vehicle with which the device is associated. Based on MIL-STD-2525 symbology definitions.

trkIdstring

UUID identifying the track, which should remain the same on subsequent tracks of the same object.

createdAtstring date-time

Time the row was created in the database.

createdBystring

Application user who created the row in the database.

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.

origNetworkstring

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

Example response

[
  {
    "id": "ORBIT_TRACK_ID",
    "classificationMarking": "U",
    "idOnOrbit": "32375",
    "satNo": 37375,
    "origObjectId": "L2045",
    "idElset": "c715a619-8695-44d2-9e7d-effd257b4843",
    "ts": "2021-02-25T12:00:00.123456Z",
    "lat": 19.88550102,
    "lon": 46.74596844,
    "alt": 585.71,
    "rdfRF": 1.5273,
    "callSign": "Charlie",
    "rptNum": "123",
    "objIdent": "FRIEND",
    "identAmp": "JOKER",
    "satStatus": "INACTIVE",
    "objectType": "PAYLOAD",
    "countryCode": "US",
    "decay": 0.5868,
    "charlieLine": "323751332255940400010000003635829600010200072500098205001150",
    "aouType": "ELLIPSE",
    "aouData": [
      34.3,
      26.5,
      1.2
    ],
    "spd": 15.03443,
    "angElev": 15.2,
    "cntnmnt": 90,
    "xref": "XE",
    "chXRef": "FHKX",
    "amplification": "A note regarding this spacecraft",
    "iff": "ID Mode",
    "vehType": "SPACE",
    "trkId": "3668f135-fcba-4630-a43d-e7782e11d988",
    "trackSensors": [
      {
        "range": 4023.95,
        "az": 90,
        "sensorNumber": 1234,
        "sensorName": "SENSOR_NAME",
        "missionNumber": "Example Mission",
        "minRangeLimit": 20.23,
        "sensorFOVType": "UNKNOWN"
      }
    ],
    "createdAt": "2021-02-25T12:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAll_84 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.