Vessels

Vessels in an area

GET
/api/v1/vessels/within

List the ships last heard in a box, by its edges in decimal degrees, the latest heard first: every ship a map shows, for example. A box may be up to 5 degrees a side, and one whose west edge is east of its east edge crosses the antimeridian.

At most 500 ships are returned; truncated says when there were more, and a smaller box or fewer kinds of ship shows them all. Each ship is where it was last heard: a moving ship has its position kept every half hour or so, a ship at anchor or alongside every two hours. Coverage depends on the region, so a ship out of reach is missing rather than shown where it was days ago.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the dashboard: a secret key (wk_sk_) from servers, or a publishable key (wk_pk_) from the origins listed on it. A workload can send its token in place of a secret key. See Authentication.

Query Parameters

south*number

The southern edge.

Range-90 <= value <= 90
west*number

The western edge.

Range-180 <= value <= 180
north*number

The northern edge.

Range-90 <= value <= 90
east*number

The eastern edge.

Range-180 <= value <= 180
category?array<>

Only ships of this kind: passenger, cargo, tanker, service, fishing or other. Repeat it for several; leave it out for all of them.

heard_within_hours?integer

Only ships heard from within this many hours, up to 72.

Range1 <= value <= 72
Default6

Response Body

The ships in the box, the latest heard first.

application/json
  1. response
results*array<>
truncated*boolean

Whether the box holds more than 500.

Example Request
curl -X GET 'https://waykite.com/api/v1/vessels/within?south=-90&west=-180&north=-90&east=-180'
Example Response
{  "results": [    {      "mmsi": 563254200,      "imo": 9987196,      "name": "CMA CGM SEINE",      "ship_category": "cargo",      "position": {        "at": "2026-10-26T19:41:27.369Z",        "lat": 51.903591666666664,        "lon": 3.4542516666666665,        "speed_kn": 0,        "course_deg": 276.3,        "heading_deg": 200,        "nav_status": 1      },      "state": "stopped",      "in_port": null    }  ],  "truncated": false}