waykiteDocs

Sea areas

Get a sea area

GET
/api/v1/sea-areas/{code}

Look up one sea area by its S-23 code, e.g. 4 for the North Sea.

Case matters: 28A is the Western Basin of the Mediterranean, 28a the Strait of Gibraltar. When no sea area has the code, the response is 204 No Content, with an empty body.

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.

Path Parameters

code*string

The sea area's S-23 code, e.g. 4.

Length1 <= length

Response Body

The sea area.

application/json
  1. response

An S-23 sea area.

code*string

Its number in S-23. Case matters: 28A is the Western Basin of the Mediterranean, 28a the Strait of Gibraltar.

name*string

Its name, as S-23 gives it.

Example Request
curl -X GET 'https://waykite.com/api/v1/sea-areas/string'
Example Response
{
  "code": "4",
  "name": "North Sea"
}

List sea areas GET

Every S-23 sea area, such as the North Sea or the Persian Gulf. Ports carry the sea area they are on in `modalities.port.sea_area`, and facilities in `sea_area`; search takes `sea_area` to keep to one. See [Regions and sea areas](https://waykite.com/docs/guides/regions-and-sea-areas).

Port arrivals GET

The ships expected at a port within the hours ahead, soonest first. Each comes with our estimate, `eta`, and the crew's own ETA beside it, `reported_eta`. Estimates are for cargo ships and tankers. A ship stays listed for a while past its estimate, until it is seen arriving. Coverage depends on the region: some ports have few ships heard near them, or none yet.