Where a vessel has been
get_vessel_trackRead-onlyIdempotent
The positions heard from one vessel over a time range, oldest first, with speed, course, and navigational status. Positions implying an impossible speed for the vessel are left out. Use for where a ship was yesterday, when it left port, or its route today. Give the vessel's mmsi, or its imo with a feeder or partner token. A call covers up to a year. By default the track is simplified by shape: the positions that hold its path, with breaks where the vessel went unheard; interval_minutes asks for even spacing instead.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | end, RFC 3339 UTC; default now | |
| imo | No | the vessel's IMO number, instead of mmsi; needs a feeder or partner token. Follows the one vessel the IMO names: its only MMSI, or the only one heard in the last 30 days | |
| from | No | start, RFC 3339 UTC; default 24 hours before to. A call covers up to 366 days | |
| mmsi | No | the vessel's MMSI; give mmsi or imo. Use search_vessels_by_name first when you only have a name | |
| limit | No | positions to return: default 50, maximum 200; when more match, the newest are kept | |
| interval_minutes | No | at most one position per this many minutes, evenly spaced; by default the track is simplified by shape instead, keeping the positions that hold its path. Anonymous and personal calls reaching past 48 hours are rounded up to whole minutes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| from | Yes | start of the range covered | |
| mmsi | Yes | ||
| name | No | ||
| breaks | No | simplified, always present and empty when the vessel was heard throughout: indexes of positions that start a stretch after it went unheard; draw no line into them | |
| positions | Yes | oldest first | |
| truncated | Yes | true when positions were left out: simplified, the tolerance rose past 15 m to fit the limit, or the range held more than 50,000 positions and the oldest were not read; by interval, the newest were kept, so set from later or raise interval_minutes | |
| interval_s | Yes | at most one position per this many seconds; 0 is every position heard. Simplified, the resolution the positions were read at | |
| simplified | Yes | true when the track was simplified by shape: the positions that hold its path, not evenly spaced | |
| attribution | Yes | credit line per source kind in the positions, to show with the data | |
| tolerance_m | No | simplified: every position left out lay within this many meters of the line through the ones kept |