Retrieve the congestion in a port using its code

GET https://api.sinay.ai/congestion/api/v1/congestion?portCode=FRLEH&vesselType=cargo

The endpoint allows you to retrieve the congestion in a port.

Request

You must use the port code (unlocode) to retrieve the congestion in a port.

You can retrieve the congestion for a vessel type (cargo, roro, tanker) using the vesselType query param

Response

In the response, you will find the congestion in percentage. It should be a value between 0 and 100. The closer it is to 100, the closer to its capacity a port is.

You will also find a gap with the mean (in percentage too). A negative gap represents a congestion which is less than average.

Example

You can find below example of request and response for this API.

Request Params

KeyDatatypeRequiredDescription
portCodestring(Required) The port code (unlocode) of the port
vesselTypestringThe congestion for a type of vessel

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"congestion":50.54,"gapWithMean":26.3}