v1

latestOpenAPI 3.1.02026-07-243613262.4 KB
Timeseries

Get the timeseries of a vessel

This endpoint returns the historical timeseries of a vessel between two dates in the past. We return the successive positions of the vessel, retrieved from both dynamic and static AIS messages.

Vessel information

The vessel can be specified either by passing its imo number or its mmsi. In the case both are given, the mmsi will be taken into account.

Dates

This endpoint takes two dates as argument to specifying the window of the timeseries. Both dates are required and can be passed using the ISO 8601 format (departureDateTime and arrivalDateTime) or the unix time in milliseconds (departure and arrival). About the time range: this endpoint returns a position point for every AIS signal received during the requested period, which can result in very large responses for active vessels over long date ranges. To ensure reliable results, we recommend keeping your date range to 3 months or less. If you need data covering a longer period, split your query into consecutive 3-month windows.

Response

The response is a Geojson FeatureCollection, where each position is represented as a Feature. Each feature gathers the properties of the position: speed over ground (kmh), draft (meters), heading (degrees), etc.

get/vessel/v2/timeseries

Query parameters

imointeger required
Example:9839179

imo number of the vessel (required if mmsi is not used)

mmsiinteger
Example:220061000

mmsi number of the vessel (required if imo not used)

departureDateTimestring required
Example:2024-08-01T00:00:00Z

Specifies the beginning of the trace in the ISO 8601 format (required if departure is not used)

departurenumber
Example:1690851066000

Specifies the begining of the trace in unix time (in ms) (required if departureDateTime is not used)

arrivalDateTimestring required
Example:2024-08-02T00:00:00Z

Specifies the end of the trace in the ISO 8601 format (required if arrival is not used)

arrivalnumber
Example:1690853876000

Specifies the end of the trace in unix time (in ms) (required if arrivalDateTime is not used)

Response

OK