Ports

Port congestion

GET
/api/v1/ports/{unlocode}/congestion

How long seagoing cargo ships and tankers waited for a berth at a port over the last 30 days, how long they stayed at it, and how many are waiting now.

A ship's wait runs from when it stopped off the port for it, at an anchorage or drifting within 50 km, or at anchor in the port, to its first berth. Each spread is the median and the 75th percentile, null where too few calls berthed to tell.

Coverage depends on the region: some ports have few ships heard near them, or none yet.

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

unlocode*string

The port's UN/LOCODE. A terminal or harbour that is part of a larger port, such as Birkenhead's GBBRK, answers for that port, which port names.

Match^[A-Z]{2}[A-Z0-9]{3}$

Response Body

Waiting and time at berth at the port.

application/json
  1. response

How long cargo ships and tankers waited for a berth at a port lately, and how long they stayed at it.

unlocode*string

The code asked for.

port*string

The port that answered: the code asked for, or the larger port it is part of, such as a terminal's.

days*integer

How many days back the calls go.

cargo*

Seagoing cargo ships.

tanker*

Seagoing tankers.

Example Request
curl -X GET 'https://waykite.com/api/v1/ports/string/congestion'
Example Response
{
  "unlocode": "NLRTM",
  "port": "NLRTM",
  "days": 30,
  "cargo": {
    "waiting_now": 9,
    "calls": 412,
    "waiting_h": {
      "median": 3.4,
      "p75": 14.8
    },
    "at_berth_h": {
      "median": 21.2,
      "p75": 33.5
    }
  },
  "tanker": {
    "waiting_now": 6,
    "calls": 287,
    "waiting_h": {
      "median": 6.1,
      "p75": 22.3
    },
    "at_berth_h": {
      "median": 28.7,
      "p75": 41.9
    }
  }
}