Skip to content
Documentation sections

Retrieve aggregated congestion data for a port

GET /congestion/{portCode} on the Congestion API. Base URL: https://api.sinay.ai/congestion/api/v1.

Returns congestion, time-in-port statistics, and vessel counts for a given port.

Path parameters

stringrequired

The port code (unlocode) of the port

Responses

Body: application/json, object.

FieldTypeRequiredDescription
portCodestringYesThe port code (unlocode).
rateOccupationobjectYes—
rateOccupation.commercialVesselsobject, nullableNo—
rateOccupation.commercialVessels.rateOccupationPercentagenumber (double), nullableNo—
rateOccupation.commercialVessels.rateOccupationGapWithMeannumber (double), nullableNo—
rateOccupation.cargoobject, nullableNo—
rateOccupation.cargo.rateOccupationPercentagenumber (double), nullableNo—
rateOccupation.cargo.rateOccupationGapWithMeannumber (double), nullableNo—
rateOccupation.tankerobject, nullableNo—
rateOccupation.tanker.rateOccupationPercentagenumber (double), nullableNo—
rateOccupation.tanker.rateOccupationGapWithMeannumber (double), nullableNo—
rateOccupation.roroobject, nullableNo—
rateOccupation.roro.rateOccupationPercentagenumber (double), nullableNo—
rateOccupation.roro.rateOccupationGapWithMeannumber (double), nullableNo—
timeobjectYes—
time.timeInPortStatisticsobject, nullableNo—
time.timeInPortStatistics.maxnumber (double), nullableNo—
time.timeInPortStatistics.mediannumber (double), nullableNo—
time.timeInPortStatistics.minnumber (double), nullableNo—
vesselsInPortCountobjectYes—
vesselsInPortCount.commercialVesselsinteger, nullableNo—
vesselsInPortCount.cargointeger, nullableNo—
vesselsInPortCount.tankerinteger, nullableNo—
vesselsInPortCount.rorointeger, nullableNo—

Response headers:

NameTypeDescription
X-Request-IdstringAn unique id to trace request accross system
X-Resource-TypestringThe type of resource returned
X-Requested-CountintegerNumber of ports requested
X-Found-CountintegerNumber of ports for which data was found

Example response body:

{
  "portCode": "FRLEH",
  "rateOccupation": {
    "commercialVessels": {
      "rateOccupationPercentage": 28.57,
      "rateOccupationGapWithMean": -25
    },
    "cargo": {
      "rateOccupationPercentage": 32.92,
      "rateOccupationGapWithMean": -1.69
    },
    "tanker": null,
    "roro": null
  },
  "time": {
    "timeInPortStatistics": {
      "max": 89.02,
      "median": 56.39,
      "min": 23.76
    }
  },
  "vesselsInPortCount": {
    "commercialVessels": 8,
    "cargo": 8,
    "tanker": 0,
    "roro": 0
  }
}