Historical positions inside a bounding box (Starter, Pro and Business plans)

Rows are returned day by day and, at raw resolution, 1° tile by tile; inside a tile ordered by vessel and time. Follow next_cursor until complete is true. At raw resolution, copies of one report received by several sources (same MMSI, timestamps at most 2 seconds and positions at most 1 metre apart) are merged into one row, the preferred source's: barentswatch, digitraffic and dma first, then aisstream, then openwaters. Rows from one source are never merged, and a copy from a source outside the plan never removes a row. Copies are matched within each day and tile.

get/v1/area

Request

  • Base URL: https://api.aistrail.com
  • URL: https://api.aistrail.com/v1/area
  • Auth: HTTP bearer

Query parameters

bboxstring

lat_min,lon_min,lat_max,lon_max; each side at most the plan's max_bbox_deg. Required unless cursor is given

fromstring date-time

ISO 8601 start (inclusive); default: to minus 1 h

tostring date-time

ISO 8601 end (exclusive); default: now on plans with live data, otherwise now minus 24 h. Later values are clamped (see meta.embargo_cutoff)

resolution'raw' | '1m' | '1h'

raw = every fix; 1m / 1h = latest fix per vessel per minute / hour (no interpolation)

format'json' | 'geojson' | 'csv' | 'xlsx'

json, geojson (application/geo+json), csv (text/csv) or xlsx (Excel workbook); csv and xlsx page through the Link / X-Next-Cursor headers

include'static' | 'none'

static = add the vessel's static data to every row (IMO, name, call sign, ship type, length, beam, draught, destination, ETA and the AIS dimensions A, B, C, D as reported at that time); none = position fields only. Default: static for csv and xlsx, none for json and geojson. No extra credits

limitinteger

Rows per page, up to the plan's track_points; the default is 5000, or track_points when that is lower

cursorstring

Opaque cursor from meta.next_cursor. When given, from, to, resolution and the subject are taken from the cursor

Response

Positions in the box

Changes

No recorded changes to this operation across all 2 revisions of this API.