Congestion Service
(getCongestionTimeseries)
GetCongestionTimeseries retrieves congestion data for a specified list of port_ids/segments
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetCongestionRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"currentTopPorts" : [ {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
}, {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
} ],
"xlsx" : "xlsx",
"currentTopCommodityGroups" : [ null, null ],
"timeseries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopLoadCountries" : [ null, null ],
"timeseriesDefault" : {
"rows" : [ {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
}, {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
} ],
"group" : "group"
},
"currentVessels" : [ {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
}, {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
} ],
"numberOfCurrentVessels" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3CongestionResponse
default
An unexpected error response. rpcStatus
post /v3/congestion/listvessels
(getCongestionVessels)
GetCongestionVessels retrieves congestion data for a specified list of port_ids/segments
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetCongestionRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"currentTopPorts" : [ {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
}, {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
} ],
"xlsx" : "xlsx",
"currentTopCommodityGroups" : [ null, null ],
"timeseries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopLoadCountries" : [ null, null ],
"timeseriesDefault" : {
"rows" : [ {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
}, {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
} ],
"group" : "group"
},
"currentVessels" : [ {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
}, {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
} ],
"numberOfCurrentVessels" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3CongestionResponse
default
An unexpected error response. rpcStatus
post /v3/congestion/web
(getCongestionWeb)
GetCongestion retrieves congestion data for a specified list of port_ids/segments
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetCongestionRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"currentTopPorts" : [ {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
}, {
"dwt" : 1.4658129805029452,
"item" : "item",
"count" : 6,
"countPercent" : 5.962133916683182,
"dwtPercent" : 5.637376656633329
} ],
"xlsx" : "xlsx",
"currentTopCommodityGroups" : [ null, null ],
"timeseries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopLoadCountries" : [ null, null ],
"timeseriesDefault" : {
"rows" : [ {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
}, {
"date" : "date",
"vesselDwt" : 7.061401241503109,
"vesselCount" : 2,
"medianWaitingDays" : 3.616076749251911,
"avgWaitingDays" : 9.301444243932576
} ],
"group" : "group"
},
"currentVessels" : [ {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
}, {
"dwt" : 4.145608029883936,
"commodity" : "commodity",
"currentPortId" : "currentPortId",
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"ladenStatus" : "ladenStatus",
"lastLoadPortName" : "lastLoadPortName",
"lastLoadPortId" : 1,
"currentCountry" : "currentCountry",
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"segment" : "segment",
"waitingTimeDays" : 7.386281948385884,
"course" : 7.457744773683766,
"lat" : 1.4894159098541704,
"commodityGroup" : "commodityGroup",
"lastLoadCountryCode" : "lastLoadCountryCode",
"lng" : 6.84685269835264,
"lastLoadBerthName" : "lastLoadBerthName",
"lastPortDepartedAt" : "lastPortDepartedAt",
"volume" : 1.0246457001441578,
"currentPortName" : "currentPortName",
"vesselName" : "vesselName",
"lastLoadCountry" : "lastLoadCountry"
} ],
"numberOfCurrentVessels" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
Responses
200
A successful response. v3CongestionResponse
default
An unexpected error response. rpcStatus