Vessels

Search vessels

GET
/api/v1/vessels/search

Find ships with an IMO number by name, IMO number, MMSI or call sign, and narrow them by flag, kind, size and the year they were built. A name matches in part, its words in any order, so ever giv finds EVER GIVEN; an IMO number, MMSI or call sign matches whole.

The best matches come first: the query exactly, then names starting with it, then the rest, the largest ships by gross tonnage first within each. Each result is a summary of the ship's particulars, as recorded; fetch those for the rest, or its position for where it is.

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

q?string

Part of a name, or an IMO number (7 digits), MMSI (9 digits) or call sign. Leave it out to list the ships that pass the filters, the largest first, with a secret key.

Lengthlength <= 100
flag?array<>

Only ships under this flag, ISO 3166-1 alpha-2, e.g. LR. Repeat it for several.

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.

min_deadweight?integer

Only ships of at least this deadweight, in tonnes.

Range0 <= value
max_deadweight?integer

Only ships of at most this deadweight, in tonnes.

Range0 <= value
built_from?integer

Only ships built in this year or later.

Range1800 <= value <= 2100
built_to?integer

Only ships built in this year or earlier.

Range1800 <= value <= 2100
limit?integer

Results per page.

Range1 <= value <= 200
Default50
offset?integer

How many results to skip, for the next page.

Range0 <= value
Default0

Response Body

A page of ships, best matches first. When offset + limit is less than total, there are more pages.

application/json
  1. response

A page of the ships a search found.

results*array<>
total*integer

How many ships match, across all pages.

limit*integer
offset*integer
Example Request
curl -X GET 'https://waykite.com/api/v1/vessels/search'
Example Response
{
  "results": [
    {
      "imo": 9811000,
      "mmsi": 636026627,
      "name": "EVER GIVEN",
      "call_sign": "A8AB9",
      "flag": "LR",
      "type": "Container ship",
      "ship_category": "cargo",
      "gross_tonnage": 219079,
      "deadweight": 199692,
      "year_built": 2018
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}