Drydock Service
(getDryDockStays)
GetDryDockStays retrives individual historical dry dock stays
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetDryDockStaysRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"previousToken" : "previousToken",
"data" : [ {
"dwt" : 1.4658129805029452,
"unlocode" : "unlocode",
"mmsi" : 6,
"imo" : 0,
"portName" : "portName",
"portId" : 5,
"departedAt" : "departedAt",
"subsegment" : "subsegment",
"durationDays" : 2.3021358869347655,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 5,
"shipyardStayId" : "shipyardStayId",
"region" : "region",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName"
}, {
"dwt" : 1.4658129805029452,
"unlocode" : "unlocode",
"mmsi" : 6,
"imo" : 0,
"portName" : "portName",
"portId" : 5,
"departedAt" : "departedAt",
"subsegment" : "subsegment",
"durationDays" : 2.3021358869347655,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 5,
"shipyardStayId" : "shipyardStayId",
"region" : "region",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName"
} ],
"nextToken" : "nextToken",
"maxResults" : 7,
"csv" : "csv"
}
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. v3GetDryDockStaysResponse
default
An unexpected error response. rpcStatus
post /v3/drydock/timeseries
(getDryDockTimeseries)
GetDryDockTimeseries retrieves dry dock timeseries 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 v3GetDryDockRequest (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",
"timeseries" : [ null, null ],
"currentTopCountries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopShipyards" : [ 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,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
}, {
"dwt" : 4.145608029883936,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
} ],
"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. v3DryDockResponse
default
An unexpected error response. rpcStatus
post /v3/drydock/listvessels
(getDryDockVessels)
GetDryDockVessels retrieves list of currently active dry dock stays 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 v3GetDryDockRequest (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",
"timeseries" : [ null, null ],
"currentTopCountries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopShipyards" : [ 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,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
}, {
"dwt" : 4.145608029883936,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
} ],
"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. v3DryDockResponse
default
An unexpected error response. rpcStatus
post /v3/drydock/web
(getDryDockWeb)
GetDryDockWeb retrieves current and live dry dock 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 v3GetDryDockRequest (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",
"timeseries" : [ null, null ],
"currentTopCountries" : [ null, null ],
"currentTopSubSegments" : [ null, null ],
"csv" : "csv",
"currentTopShipyards" : [ 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,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
}, {
"dwt" : 4.145608029883936,
"lng" : 6.84685269835264,
"subSegment" : "subSegment",
"currentCountryCode" : "currentCountryCode",
"imo" : 2,
"portName" : "portName",
"portId" : 7,
"speed" : 1.1730742509559433,
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"shipyardId" : 1,
"waitingTimeDays" : 1.0246457001441578,
"course" : 7.457744773683766,
"countryName" : "countryName",
"shipyardName" : "shipyardName",
"lat" : 1.4894159098541704,
"vesselName" : "vesselName"
} ],
"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. v3DryDockResponse
default
An unexpected error response. rpcStatus