--- title: "GET /udl/ais/history" method: GET path: "/udl/ais/history" tags: ["AIS"] --- # GET /udl/ais/history `GET /udl/ais/history` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/ais/history` - Auth: none declared Service operation to dynamically query historical data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `columns` string - `ts` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - AISFull[] - `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. - `idTrack` string: Unique identifier of the Track. - `idVessel` string: Unique identifier of the vessel. - `mmsi` integer: The Maritime Mobile Service Identity of the vessel. MMSI is a nine-digit number that identifies the transmitter station of the vessel. - `imon` integer: The International Maritime Organization Number of the vessel. IMON is a seven-digit number that uniquely identifies the vessel. - `ts` string, date-time, required: The timestamp that the vessel position was recorded, in ISO 8601 UTC format. - `shipName` string: The name of the vessel. Vessel names that exceed the AIS 20 character are shortened (not truncated) to 15 character-spaces, followed by an underscore and the last 4 characters-spaces of the vessel full name. - `shipType` string: The reported ship type (e.g. Passenger, Tanker, Cargo, Other, etc.). See the engagedIn and specialCraft entries for additional information on certain types of vessels. - `engagedIn` string: The activity that the vessel is engaged in. This entry applies only when the shipType = Other. - `specialCraft` string: The type of special craft designation of the vessel. This entry applies only when the shipType = Special Craft. - `cargoType` string: The reported cargo type. Intended as, but not constrained to, the USCG NAVCEN AIS cargo definitions. Users should refer to USCG Navigation Center documentation for specific definitions associated with ship and cargo types. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov. - `callSign` string: A uniquely designated identifier for the vessel's transmitter station. - `vesselFlag` string: The flag of the subject vessel according to AIS transmission. - `lat` number, double: WGS-84 latitude of the vessel position, in degrees. -90 to 90 degrees (negative values south of equator). - `lon` number, double: WGS-84 longitude of the vessel position, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `posHiAccuracy` boolean: Flag indicating high reported position accuracy (less than or equal to 10 meters). A value of 0/false indicates low accuracy (greater than 10 meters). - `posHiLatency` boolean: Flag indicating high reported position latency (greater than 5 seconds). A value of 0/false indicates low latency (less than 5 seconds). - `speed` number, double: The speed-over-ground reported by the vessel, in kilometers/hour. - `trueHeading` number, double: The true heading reported by the vessel, in degrees. - `course` number, double: The course-over-ground reported by the vessel, in degrees. - `rateOfTurn` number, double: The Rate-of-Turn for the vessel, in degrees/minute. Positive value indicates that the vessel is turning right. - `specialManeuver` boolean: Flag indicating that the vessel is engaged in a special maneuver (e.g. Waterway Navigation). - `navStatus` string: The AIS Navigational Status of the vessel (e.g. Underway Using Engine, Moored, Aground, etc.). Intended as, but not constrained to, the USCG NAVCEN navigation status definitions. Users should refer to USCG Navigation Center documentation for specific definitions associated with navigation status. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov. - `posDeviceType` string: The type of electronic position fixing device (e.g. GPS, GLONASS, etc.). Intended as, but not constrained to, the USCG NAVCEN electronic position fixing device definitions. Users should refer to USCG Navigation Center documentation for specific device type information. USCG NAVCEN documentation may be found at https://www.navcen.uscg.gov. - `antennaRefDimensions` number[]: The reference dimensions of the vessel, reported as [A, B, C, D], in meters. Where the array values represent the distance fore (A), aft (B), to port (C), and to starboard (D) of the navigation antenna. Array with values A = C = 0 and B, D > 0 indicate the length (B) and width (D) of the vessel without antenna position reference. - `length` number, double: The overall length of the vessel, in meters. A value of 511 indicates a vessel length of 511 meters or greater. - `width` number, double: The breadth of the vessel, in meters. A value of 63 indicates a vessel breadth of 63 meters or greater. - `draught` number, double: The maximum static draught, in meters, of the vessel according to the AIS transmission. - `shipDescription` string: Further description or explanation of the vessel or type. - `destination` string: The destination of the vessel according to the AIS transmission. - `destinationETA` string, date-time: The Estimated Time of Arrival of the vessel at the destination, in ISO 8601 UTC format. - `currentPortGUID` string: The US Geographic Unique Identifier of the current port hosting the vessel. - `currentPortLOCODE` string: The UN Location Code of the current port hosting the vessel. - `lastPortGUID` string: The US Geographic Unique Identifier of the last port visited by the vessel. - `lastPortLOCODE` string: The UN Location Code of the last port visited by the vessel. - `nextPortGUID` string: The US Geographic Unique Identifier of the next destination port of the vessel. - `nextPortLOCODE` string: The UN Location Code of the next destination port of the vessel. - `etaCalculated` string, date-time: The Estimated Time of Arrival of the vessel at the destination port, according to MarineTraffic calculations, in ISO 8601 UTC format. - `etaUpdated` string, date-time: The date and time that the ETA was calculated by MarineTraffic, in ISO 8601 UTC format. - `distanceToGo` number, double: The remaining distance, in kilometers, for the vessel to reach the reported destination. - `distanceTravelled` number, double: The distance, in kilometers, that the vessel has travelled since departing the last port. - `avgSpeed` number, double: The average speed, in kilometers/hour, calculated for the subject vessel during the latest voyage (port to port). - `maxSpeed` number, double: The maximum speed, in kilometers/hour, reported by the subject vessel during the latest voyage (port to port). - `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. - `sourceDL` string: 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. - `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. - `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. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. ## 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 `findAllHistory` 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/ais/history/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)