API Reference

Get trace of vessel

get
https://api.searoutes.com/vessel/v2/trace

This endpoint returns the historical trace of a given vessel between two dates in the past. The successive positions of the vessel are retrieved from AIS and processed to determine the geometry and route statistics.

Vessel information

The vessel can be identified either by 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 for the beginning and the end of the trace. Both are required and can be passed using the ISO 8601 format (departureDateTime and arrivalDateTime) or the unix time in milliseconds (departure and arrival).

Response

The response is a Geojson FeatureCollection. The trace is represented as a Feature : its geometry is a MultiLineString (cut at the antimeridian if crossed) and its properties give information about the route (distance, areas crossed, average speed). Total distance + distances in Seca zones and HRA are returned. Note that the average speed is computed for the entire trace. If the vessel stops multiple days, the average speed can be low.

Query Params
integer
required
Defaults to 9839179

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

integer

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

string
required
Defaults to 2024-08-01T00:00:00Z

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

number

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

string
required
Defaults to 2024-08-02T00:00:00Z

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

number

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

Responses

Updated 3 months ago

Language
Credentials
Header
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago