Oceanbolt Data API
This API provides access to the data available in the Oceanbolt Data Platform. The API is accessible on the following base url: https://api.oceanbolt.com/v3.
Introduction
This API is documented in OpenAPI format. The api allows for programmatic access to the different data resources that are also accessible in the Oceanbolt Data Platform. The resources are grouped into the following categories:
Congestion: congestion data
Tonnage: tonnage and speed related data
Trade Flows: trade flow data
Dry dock: individual dry dock stays on the vessel level and summary timeseries for dry dockings
Port Calls: Historic list of port calls on either vessel/port level
Entities: listing of various database entities in the Oceanbolt Platform
Fleet Management: management user defined fleets
Polygon Management: management user defined polygon layers
Detailed information on how to query and filter the data is available in the documentation on the individual endpoints.
Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
Authentication
Authentication to the Oceanbolt Data Api is done through bearer token. To make calls to the API, send the API token in the Authorization HTTP header using the Bearer authentication scheme. You can create access tokens from your profile page on: Oceanbolt Data Platform. Access tokens should be provided as a bearer token, e.g. it should be in the form of a header with the following format:
Authorization: Bearer <TOKEN>
Base url
Base url:
https://api.oceanbolt.com
More information: https://openapi.oceanbolt.com
Contact Info: support@oceanbolt.com
Version: 3.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]
Table of Contents
CongestionService
CustomPolygonService
post /v3/custompolygons/search
DistanceCalculatorService
DrydockService
EntityService
FleetManagementService
LiveStateService
PolygonManagementService
PortCallService
SustainabilityService
TonnageService
TradeFlowService
VesselService
VesselStateService
CongestionService
post /v3/congestion/timeseries
(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
CustomPolygonService
post /v3/custompolygons/search
(getPolygonCounts)
GetPolygonCounts returns vessels counts (points) in polygon the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CustomPolygonRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
} ]
}
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. v3CustomPolygonResponse
default
An unexpected error response. rpcStatus
DistanceCalculatorService
post /v3/batch-calculate-distance
(batchCalculateDistance)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3BatchDistanceRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"responses" : [ {
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
}, {
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
} ]
}
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. v3BatchDistanceResponse
default
An unexpected error response. rpcStatus
post /v3/calculate-distance
(calculateDistance)
Calculates distances for the shortest route between a two or more locations. Distances are returned both for the voyage as a whole, and individually for each leg of the voyage. Endpoint also returns the shortest route as a series of points. If speed is specified, expected duration of the voyage will also be returned.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3DistanceRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
}
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. v3DistanceResponse
default
An unexpected error response. rpcStatus
DrydockService
post /v3/drydock/liststays
(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
EntityService
get /v3/entities/commodities
(listCommodities)
ListCommodities retrives all commodities
Return type
Example data
Content-Type: application/json
{
"commodities" : [ {
"commodityGroup" : "commodityGroup",
"commodity" : "commodity",
"commodityValue" : "commodityValue",
"commodityId" : 0,
"platform" : "platform"
}, {
"commodityGroup" : "commodityGroup",
"commodity" : "commodity",
"commodityValue" : "commodityValue",
"commodityId" : 0,
"platform" : "platform"
} ]
}
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. v3ListCommoditiesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/countries
(listCountries)
ListCountries retrives all countries
Return type
Example data
Content-Type: application/json
{
"countries" : [ {
"country" : "country",
"countryCode" : "countryCode"
}, {
"country" : "country",
"countryCode" : "countryCode"
} ]
}
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. v3ListCountriesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/ports
(listPorts)
ListPorts retrieves all ports
Return type
Example data
Content-Type: application/json
{
"ports" : [ {
"unlocode" : "unlocode",
"unlocodeAlias" : [ "unlocodeAlias", "unlocodeAlias" ],
"countryCode" : "countryCode",
"portName" : "portName",
"portId" : 0,
"region" : "region",
"portNameAlias" : [ "portNameAlias", "portNameAlias" ]
}, {
"unlocode" : "unlocode",
"unlocodeAlias" : [ "unlocodeAlias", "unlocodeAlias" ],
"countryCode" : "countryCode",
"portName" : "portName",
"portId" : 0,
"region" : "region",
"portNameAlias" : [ "portNameAlias", "portNameAlias" ]
} ]
}
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. v3ListPortsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/regions
(listRegions)
ListRegions retrives all regions
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"regionId" : "regionId",
"regionName" : "regionName"
}, {
"regionId" : "regionId",
"regionName" : "regionName"
} ]
}
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. v3ListRegionsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/regionswithpolygons
(listRegionsWithPolygons)
ListRegionsWithPolygons retrives all regions with geo polygons
Return type
v3ListRegionsWithPolygonResponse
Example data
Content-Type: application/json
{
"regions" : [ {
"geojson" : "geojson",
"regionId" : "regionId",
"regionName" : "regionName"
}, {
"geojson" : "geojson",
"regionId" : "regionId",
"regionName" : "regionName"
} ]
}
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. v3ListRegionsWithPolygonResponse
default
An unexpected error response. rpcStatus
get /v3/entities/segments
(listSegments)
ListSegments retrieves all available vessel segments
Return type
Example data
Content-Type: application/json
{
"segments" : [ {
"highlevelType" : "highlevelType",
"segment" : "segment",
"segmentKey" : "segmentKey",
"subSegment" : "subSegment",
"segmentInt" : 0,
"cutoffHigh" : 5.962133916683182,
"subSegmentInt" : 6,
"subSegmentKey" : "subSegmentKey",
"cutoffLow" : 1.4658129805029452,
"platform" : "platform"
}, {
"highlevelType" : "highlevelType",
"segment" : "segment",
"segmentKey" : "segmentKey",
"subSegment" : "subSegment",
"segmentInt" : 0,
"cutoffHigh" : 5.962133916683182,
"subSegmentInt" : 6,
"subSegmentKey" : "subSegmentKey",
"cutoffLow" : 1.4658129805029452,
"platform" : "platform"
} ]
}
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. v3ListSegmentsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/zones
(listZones)
ListZones retrieves all zones
Return type
Example data
Content-Type: application/json
{
"zones" : [ {
"zoneId" : 0,
"zoneName" : "zoneName"
}, {
"zoneId" : 0,
"zoneName" : "zoneName"
} ]
}
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. v3ListTonnageZonesResponse
default
An unexpected error response. rpcStatus
get /v3/entities/zoneswithpolygon
(listZonesWithPolygons)
ListZonesWithPolygons retrieves all zones with Polygons
Return type
v3ListTonnageZonesWithPolygonsResponse
Example data
Content-Type: application/json
{
"zones" : [ {
"geomPolygonWkt" : "geomPolygonWkt",
"zoneId" : 0,
"geomCoordinateGeojson" : "geomCoordinateGeojson",
"zoneName" : "zoneName",
"zoneBasin" : "zoneBasin",
"geomPolygonGeojson" : "geomPolygonGeojson",
"geomCoordinateWkt" : "geomCoordinateWkt"
}, {
"geomPolygonWkt" : "geomPolygonWkt",
"zoneId" : 0,
"geomCoordinateGeojson" : "geomCoordinateGeojson",
"zoneName" : "zoneName",
"zoneBasin" : "zoneBasin",
"geomPolygonGeojson" : "geomPolygonGeojson",
"geomCoordinateWkt" : "geomCoordinateWkt"
} ]
}
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. v3ListTonnageZonesWithPolygonsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/polygons/search
(searchPolygons)
Query parameters
q (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"polygons" : [ {
"unlocode" : "unlocode",
"berthId" : 0,
"countryCode" : "countryCode",
"entityType" : "entityType",
"alias" : "alias",
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName"
}, {
"unlocode" : "unlocode",
"berthId" : 0,
"countryCode" : "countryCode",
"entityType" : "entityType",
"alias" : "alias",
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName"
} ]
}
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. v3SearchPolygonsResponse
default
An unexpected error response. rpcStatus
get /v3/entities/vessels/search
(searchVessels)
Query parameters
q (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"vessels" : [ {
"dwt" : 6.027456183070403,
"beam" : 2.3021358869347655,
"highlevelType" : "highlevelType",
"built" : 5,
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 0,
"type" : "type",
"holdsTotal" : 7.061401241503109,
"mpv" : true,
"maxDraught" : 1.4658129805029452,
"segment" : "segment",
"name" : "name",
"loa" : 5.637376656633329
}, {
"dwt" : 6.027456183070403,
"beam" : 2.3021358869347655,
"highlevelType" : "highlevelType",
"built" : 5,
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 0,
"type" : "type",
"holdsTotal" : 7.061401241503109,
"mpv" : true,
"maxDraught" : 1.4658129805029452,
"segment" : "segment",
"name" : "name",
"loa" : 5.637376656633329
} ]
}
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. v3SearchVesselsResponse
default
An unexpected error response. rpcStatus
FleetManagementService
post /v3/fleets/{fleetId}/vessels
(addVessel)
Adds new vessel to a Fleet. A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for adding a Vessel to a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}
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. v3Vessel1
default
An unexpected error response. rpcStatus
post /v3/fleets/{fleetId}/batch-add-vessels
(batchAddVessels)
Batch adds vessels into a Fleet. A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for batch adding Vessels to a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
post /v3/fleets
(createFleet)
Creates a new Fleet for the current user.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CreateFleetRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}
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. v3Fleet
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}
(deleteFleet)
Deletes a Fleet for the current user.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be deleted.
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}/vessels/{imo}
(deleteVessel)
Removes a vessel from a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where the vessel should be deleted.
imo (required)
Path Parameter — IMO number of the Vessel to be deleted. format: int32
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}
(describeFleet)
Retrieves fleet by Fleet id.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be retrieved.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}
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. v3Fleet
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}/drop-vessels
(dropVessels)
Drops all the vessels currently in a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be dropped.
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
get /v3/fleets/livemap
(getFleetLiveMap)
GetFleetLiveMap display static location for vessels in a fleet (as static image).
Query parameters
fleetId (optional)
Query Parameter — Identifier of the Fleet resource.
mapTheme (optional)
Query Parameter — Specifies the map theme. Allowed values are: [light-v10, dark-v10, navigation-night-v1, navigation-day-v1, outdoors-v11, satellite-v9].
Return type
Example data
Content-Type: application/json
{
"mapImage" : "mapImage"
}
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. v3GetFleetLiveMapResponse
default
An unexpected error response. rpcStatus
get /v3/fleets
(listFleets)
Lists Fleets for the current user (or fleets that are shared with the current user)
Return type
Example data
Content-Type: application/json
{
"predefinedFleets" : [ null, null ],
"organizationFleets" : [ null, null ],
"fleets" : [ {
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}, {
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
} ]
}
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. v3Fleets
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}/vessels
(listVessels)
Retrieves list of vessels in a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource which vessels to be retrieved.
Return type
Example data
Content-Type: application/json
{
"vesselsInFleet" : 0,
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ]
}
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. v3Vessels
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}/vessels-with-status
(listVesselsWithStatus)
Retrieves list of vessels in a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource which vessels to be retrieved.
Query parameters
lastDays (optional)
Query Parameter — Number of last days from now for vessel StoppageEvents to be retrieved. Cannot be used alongside start_date and end_date. format: int32
startDate (optional)
Query Parameter — The UTC start date of the date filter for related events (StoppageEvents etc.).
endDate (optional)
Query Parameter — The UTC end date of the date filter for related events (StoppageEvents etc.).
Return type
Example data
Content-Type: application/json
{
"vesselsInFleet" : 0,
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ]
}
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. v3Vessels
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/rename-fleet
(renameFleet)
Changes the name of a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be renamed.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for renaming a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}
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. v3Fleet
default
An unexpected error response. rpcStatus
post /v3/fleets/{fleetId}/replace-vessels
(replaceVessels)
Replaces the existing vessels in a Fleet with a batch of new vessels. This is equivalent to first calling DropVessels and then calling BatchAddVessels A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for batch adding Vessels to a Fleet_1 (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/share-fleet
(shareFleet)
Sets the shared status of the Fleet to be shared.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}
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. v3Fleet
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/unshare-fleet
(unshareFleet)
Sets the shared status of the Fleet to be not shared.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}
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. v3Fleet
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/vessels/{imo}
(updateVessel)
Updates existing metadata for a Vessel.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where the vessel should be updated.
imo (required)
Path Parameter — IMO number of the vessel to be updated. format: int32
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for updating a vessel (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}
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. v3Vessel1
default
An unexpected error response. rpcStatus
post /v3/fleets/upload-fleet-list
(uploadFleetList)
Uploads file containing fleet data to be parsed into a batch of vessels.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetFleetListRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
LiveStateService
post /v3/livestates/aisquality
(aisQuality)
AisQuality returns the overview of how many positions reseived for vessels in different time periods
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3LiveStateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselSegmentsByTime" : [ {
"data" : [ {
"count" : 1,
"from" : 0,
"to" : 6
}, {
"count" : 1,
"from" : 0,
"to" : 6
} ],
"subSegment" : "subSegment"
}, {
"data" : [ {
"count" : 1,
"from" : 0,
"to" : 6
}, {
"count" : 1,
"from" : 0,
"to" : 6
} ],
"subSegment" : "subSegment"
} ],
"zonesBySegment" : [ {
"data" : [ {
"subSegment" : "subSegment",
"count" : 5
}, {
"subSegment" : "subSegment",
"count" : 5
} ],
"zoneName" : "zoneName"
}, {
"data" : [ {
"subSegment" : "subSegment",
"count" : 5
}, {
"subSegment" : "subSegment",
"count" : 5
} ],
"zoneName" : "zoneName"
} ],
"zonesByTime" : [ {
"data" : [ null, null ],
"zoneName" : "zoneName"
}, {
"data" : [ null, null ],
"zoneName" : "zoneName"
} ]
}
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. v3AisQualityResponse
default
An unexpected error response. rpcStatus
post /v3/livestates/vessels
(vessels)
Vessels gets a list of vessels for the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3LiveStateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"csv" : "csv",
"vessels" : [ {
"lastPositionReceived" : "lastPositionReceived",
"dwt" : 1.4658129805029452,
"mmsi" : 6,
"berthId" : 7,
"subSegment" : "subSegment",
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"portName" : "portName",
"ladenStatus" : "ladenStatus",
"navigationalStatus" : 2,
"portId" : 5,
"berthName" : "berthName",
"speed" : 4.145608029883936,
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"cargoStatus" : "cargoStatus",
"eta" : "eta",
"segment" : "segment",
"shipyardId" : 9,
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"direction" : "direction",
"commodityGroup" : "commodityGroup",
"destinationRegion" : "destinationRegion",
"lastStaticReceived" : "lastStaticReceived",
"anchorageId" : 2,
"anchorageName" : "anchorageName",
"lastPortName" : "lastPortName",
"lastCountryCode" : "lastCountryCode",
"lastRegion" : "lastRegion",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"commodityName" : "commodityName"
}, {
"lastPositionReceived" : "lastPositionReceived",
"dwt" : 1.4658129805029452,
"mmsi" : 6,
"berthId" : 7,
"subSegment" : "subSegment",
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"portName" : "portName",
"ladenStatus" : "ladenStatus",
"navigationalStatus" : 2,
"portId" : 5,
"berthName" : "berthName",
"speed" : 4.145608029883936,
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"cargoStatus" : "cargoStatus",
"eta" : "eta",
"segment" : "segment",
"shipyardId" : 9,
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"direction" : "direction",
"commodityGroup" : "commodityGroup",
"destinationRegion" : "destinationRegion",
"lastStaticReceived" : "lastStaticReceived",
"anchorageId" : 2,
"anchorageName" : "anchorageName",
"lastPortName" : "lastPortName",
"lastCountryCode" : "lastCountryCode",
"lastRegion" : "lastRegion",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"commodityName" : "commodityName"
} ]
}
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. v3VesselsResponse
default
An unexpected error response. rpcStatus
post /v3/livestates/inarea
(vesselsInArea)
VesselsInArea gets vessels as geo objects in rectangular area for the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3LiveStateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselsReturned" : 6,
"vesselsTotal" : 0,
"vesselsInView" : 1,
"vessels" : [ {
"mmsi" : 5,
"geomCoordinates" : "geomCoordinates",
"course" : 2.3021358869347655,
"imo" : 5,
"ladenStatus" : "ladenStatus",
"speed" : 7.061401241503109,
"vesselName" : "vesselName"
}, {
"mmsi" : 5,
"geomCoordinates" : "geomCoordinates",
"course" : 2.3021358869347655,
"imo" : 5,
"ladenStatus" : "ladenStatus",
"speed" : 7.061401241503109,
"vesselName" : "vesselName"
} ]
}
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. v3VesselsInAreaResponse
default
An unexpected error response. rpcStatus
PolygonManagementService
post /v3/layers/{layerId}/polygons
(addPolygon)
AddPolygon adds new vessel to user's layer
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3PolygonParams (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}
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. v3Polygon1
default
An unexpected error response. rpcStatus
post /v3/layers/{layerId}/batch-add-polygons
(batchAddPolygons)
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_batchaddpolygons_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
post /v3/layers
(createLayer)
CreateLayer creates new layer for the current user
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CreateLayerRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}
(deleteLayer)
DeleteLayer deletes layer for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}/polygons/{polygonId}
(deletePolygon)
DeletePolygon removes vessel from user's layer
Path parameters
layerId (required)
Path Parameter —
polygonId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
get /v3/layers/{layerId}
(describeLayer)
GetLayer gets fleed by layer id for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}/drop-polygons
(dropPolygons)
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
get /v3/layers
(listLayers)
ListLayers lists layers for the current user
Return type
Example data
Content-Type: application/json
{
"layers" : [ {
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}, {
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
} ],
"predefinedLayers" : [ null, null ]
}
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. v3Layers
default
An unexpected error response. rpcStatus
get /v3/layers/{layerId}/polygons
(listPolygons)
GetLayerPolygons gets layer polygons for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"polygonsInLayer" : 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. v3Polygons
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/rename-layer
(renameLayer)
RenameLayer changes the name of the layer for the current user
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_renamelayer_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
post /v3/layers/{layerId}/replace-polygons
(replacePolygons)
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_replacepolygons_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/share-layer
(shareLayer)
Sets the shared status of the layer to be either shared/not shared
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/unshare-layer
(unshareLayer)
Sets the shared status of the layer to be either shared/not shared
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/polygons/{polygonId}
(updatePolygon)
UpdatePolygon updates existing vessel to user's layer
Path parameters
layerId (required)
Path Parameter —
polygonId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3PolygonParams (required)
Body Parameter —
Query parameters
upsert (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}
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. v3Polygon1
default
An unexpected error response. rpcStatus
PortCallService
post /v3/portcalls/timeseries
(getPortCallTimeseries)
GetPortCallTimeseries retrieves aggregated counts for port calls for a set of request params.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortCallsRequest (required)
Body Parameter —
Return type
v3GetPortCallTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
} ],
"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. v3GetPortCallTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/portcalls/listportcalls
(getPortCalls)
ListPortCalls retrieves lists all port calls for a set of request params. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of port calls to return per query, default is 50 and maximum is 2000.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortCallsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"commodity" : "commodity",
"unberthedAt" : "unberthedAt",
"daysInPort" : 5.637376656633329,
"berthId" : 1,
"subSegment" : "subSegment",
"imo" : 0,
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"daysAtBerth" : 7.061401241503109,
"portVisited" : true,
"daysWaiting" : 2.3021358869347655,
"berthedAt" : "berthedAt",
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"departedAt" : "departedAt",
"anchorageId" : 5,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
}, {
"commodity" : "commodity",
"unberthedAt" : "unberthedAt",
"daysInPort" : 5.637376656633329,
"berthId" : 1,
"subSegment" : "subSegment",
"imo" : 0,
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"daysAtBerth" : 7.061401241503109,
"portVisited" : true,
"daysWaiting" : 2.3021358869347655,
"berthedAt" : "berthedAt",
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"departedAt" : "departedAt",
"anchorageId" : 5,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
} ],
"nextToken" : "nextToken",
"csv" : "csv",
"prevToken" : "prevToken"
}
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. v3GetPortCallsResponse
default
An unexpected error response. rpcStatus
post /v3/port/particulars
(getPortParticulars)
ListPortCalls retrieves lists all port calls for a given vessel. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of port calls to return per query, default is 50 and maximum is 2000.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortParticularsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"numberOfPortCalls" : 0,
"loa" : {
"percentile10" : 5.962133916683182,
"min" : 6.027456183070403,
"percentile99" : 9.301444243932576,
"max" : 1.4658129805029452,
"percentile50" : 5.637376656633329,
"mean" : 3.616076749251911,
"percentile95" : 7.061401241503109,
"percentile90" : 2.3021358869347655
}
}
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. v3GetPortParticularsResponse
default
An unexpected error response. rpcStatus
post /v3/portcalls/vessels-in-port
(getVesselsInPort)
GetVesselsInPort lists all vessels that were within a port (or related anchorages) at a certain time.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetVesselsInPortRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"dwt" : 5.962133916683182,
"commodity" : "commodity",
"berthStays" : [ {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
}, {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
} ],
"daysInPort" : 7.061401241503109,
"berthId" : 5,
"subSegment" : "subSegment",
"imo" : 6,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"portId" : 1,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"portVisited" : true,
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"anchorageStays" : [ {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
}, {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
} ],
"departedAt" : "departedAt",
"anchorageId" : 2,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
}, {
"dwt" : 5.962133916683182,
"commodity" : "commodity",
"berthStays" : [ {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
}, {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
} ],
"daysInPort" : 7.061401241503109,
"berthId" : 5,
"subSegment" : "subSegment",
"imo" : 6,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"portId" : 1,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"portVisited" : true,
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"anchorageStays" : [ {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
}, {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
} ],
"departedAt" : "departedAt",
"anchorageId" : 2,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
} ],
"vesselsInPort" : 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. v3GetVesselsInPortResponse
default
An unexpected error response. rpcStatus
SustainabilityService
post /v3/sustainability/corrupt-port-calls-summary
(getCorruptPortCalls)
GetCorruptPortCalls retrieves lists of all port calls inside corrupt ports.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetCorruptPortCallsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"visits" : [ {
"countryCode" : "countryCode",
"numberOfPortCalls" : 0
}, {
"countryCode" : "countryCode",
"numberOfPortCalls" : 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. v3GetCorruptPortCallsResponse
default
An unexpected error response. rpcStatus
get /v3/sustainability/marine-protected-area-stays
(getMarineProtectedAreaStays)
GetMarineProtectedAreaStats retrieves lists of all stays inside marine protected areas for a single vessel.
Query parameters
imo (optional)
Query Parameter — format: int32
startDate (optional)
Query Parameter —
endDate (optional)
Query Parameter —
format (optional)
Query Parameter —
Return type
v3GetMarineProtectedAreaStaysResponse
Example data
Content-Type: application/json
{
"file" : "file",
"mpaStays" : [ {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
}, {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
} ]
}
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. v3GetMarineProtectedAreaStaysResponse
default
An unexpected error response. rpcStatus
post /v3/sustainability/marine-protected-area-summary
(getMarineProtectedAreaSummary)
GetMarineProtectedAreaStats retrieves lists of all stays inside marine protected areas.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetMarineProtectedAreaSummaryRequest (required)
Body Parameter —
Return type
v3GetMarineProtectedAreaSummaryResponse
Example data
Content-Type: application/json
{
"file" : "file",
"summaryRows" : [ {
"totalDurationDays" : 6.027456183070403,
"endDate" : "endDate",
"totalDistanceTraveledNm" : 5.637376656633329,
"imo" : 0,
"startDate" : "startDate",
"totalDurationHours" : 1.4658129805029452,
"vesselName" : "vesselName",
"avgSpeed" : 5.962133916683182
}, {
"totalDurationDays" : 6.027456183070403,
"endDate" : "endDate",
"totalDistanceTraveledNm" : 5.637376656633329,
"imo" : 0,
"startDate" : "startDate",
"totalDurationHours" : 1.4658129805029452,
"vesselName" : "vesselName",
"avgSpeed" : 5.962133916683182
} ],
"mpaStays" : [ {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
}, {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
} ]
}
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. v3GetMarineProtectedAreaSummaryResponse
default
An unexpected error response. rpcStatus
TonnageService
post /v3/tonnage/zone/global
(getGlobalTonnageStatus)
Fetches global tonnage status timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
v3GetGlobalTonnageStatusResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"globalTonnageZoneCounts" : [ {
"date" : "date",
"vesselDwt" : 1.4658129805029452,
"vesselCount" : 6,
"zoneId" : 0,
"zoneName" : "zoneName",
"avgSpeed" : 5.962133916683182
}, {
"date" : "date",
"vesselDwt" : 1.4658129805029452,
"vesselCount" : 6,
"zoneId" : 0,
"zoneName" : "zoneName",
"avgSpeed" : 5.962133916683182
} ],
"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. v3GetGlobalTonnageStatusResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/basin
(getTonnageBasinCount)
Provides timeseries data on the number of vessels that are within the four major basins.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageBasinRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"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. v3GetTonnageBasinResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/chinesewaters
(getTonnageChineseWaters)
Provides chinese waters tonnage timeseries data. This timeseries shows the number of Chinese flagged that are trading inside and outside of Chinese waters respectively.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TonnageChineseWatersRequest (required)
Body Parameter —
Return type
v3TonnageChineseWatersResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
}, {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
}, {
"date" : "date",
"insideChineseWatersDwt" : 6.027456183070403,
"outsideChineseWatersCount" : 1,
"insideChineseWatersCount" : 0,
"outsideChineseWatersDwt" : 5.962133916683182
} ],
"group" : "group"
} ],
"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. v3TonnageChineseWatersResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/fleetgrowth
(getTonnageFleetGrowth)
Provides fleet growth timeseries of how the fleet have developed over time. This timeseries shows number of vessels added to/removed from the fleet during any given period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageFleetRequest (required)
Body Parameter —
Return type
v3GetTonnageFleetGrowthResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
}, {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
}, {
"date" : "date",
"scrapped" : 0.8008281904610115,
"delivered" : 6.027456183070403,
"net" : 1.4658129805029452
} ],
"group" : "group"
} ],
"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. v3GetTonnageFleetGrowthResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/speed
(getTonnageFleetSpeed)
Fetches fleet speed timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"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. v3GetFleetSpeedResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/fleetstatus
(getTonnageFleetStatus)
Provides fleet status timeseries of how the fleet have developed over time. This timeseries shows number of active vessels on the water at any given time.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageFleetRequest (required)
Body Parameter —
Return type
v3GetTonnageFleetStatusResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
} ],
"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. v3GetTonnageFleetStatusResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/zonechanges
(getTonnageZoneChanges)
Provides timeseries data on the number of vessels that cross zone boundaries during any given period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageZoneChangesRequest (required)
Body Parameter —
Return type
v3GetTonnageZoneChangesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0
} ],
"group" : "group"
} ],
"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. v3GetTonnageZoneChangesResponse
default
An unexpected error response. rpcStatus
post /v3/tonnage/zone
(getTonnageZoneCount)
Fetches tonnage counts timeseries.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetTonnageDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
}, {
"date" : "date",
"vesselDwt" : 6.027456183070403,
"vesselCount" : 0,
"avgSpeed" : 1.4658129805029452
} ],
"group" : "group"
} ],
"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. v3GetTonnageZoneCountResponse
default
An unexpected error response. rpcStatus
TradeFlowService
post /v3/tradeflows/toplocations
(getLocationVolume)
GetLocationVolume gets location (port/berth/country/region) flow stats for the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"locationName" : "locationName",
"locationId" : "locationId",
"countryCode" : "countryCode",
"locationType" : "locationType",
"value" : 0.8008281904610115,
"coords" : {
"lon" : 1.4658129805029452,
"lat" : 6.027456183070403
}
}, {
"locationName" : "locationName",
"locationId" : "locationId",
"countryCode" : "countryCode",
"locationType" : "locationType",
"value" : 0.8008281904610115,
"coords" : {
"lon" : 1.4658129805029452,
"lat" : 6.027456183070403
}
} ]
}
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. v3GetLocationVolumeResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/aggregation
(getTradeFlowAggregation)
Aggregates tradeflow data across multiple dimensions.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowAggregationResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"rows" : [ {
"category" : "category",
"value" : 0.8008281904610115
}, {
"category" : "category",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"category" : "category",
"value" : 0.8008281904610115
}, {
"category" : "category",
"value" : 0.8008281904610115
} ],
"group" : "group"
} ],
"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. v3GetTradeFlowAggregationResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/histogram
(getTradeFlowHistogram)
GetTradeFlowHistogramValues gets trade flow histogram values by grouping.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowHistogramResponse
Example data
Content-Type: application/json
{
"groupingVariable" : "groupingVariable",
"numberOfGroups" : 0,
"groups" : [ {
"numberOfValues" : 6,
"values" : [ 1.4658129805029452, 1.4658129805029452 ],
"group" : "group"
}, {
"numberOfValues" : 6,
"values" : [ 1.4658129805029452, 1.4658129805029452 ],
"group" : "group"
} ]
}
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. v3GetTradeFlowHistogramResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/onthewater
(getTradeFlowOnTheWater)
Gets aggregated trade flow timeseries (on the water) by period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
} ],
"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. v3GetTradeFlowTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/timeseries
(getTradeFlowTimeseries)
Gets aggregated trade flow timeseries by period.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
v3GetTradeFlowTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
} ],
"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. v3GetTradeFlowTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/listflows
(getTradeFlows)
GetVoyages retrieves all the individual voyages for the given filter parameters. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of voyages to return per query.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"loadPortUnberthedAt" : "loadPortUnberthedAt",
"ballastStartedAt" : "ballastStartedAt",
"subSegment" : "subSegment",
"dischargeCountry" : "dischargeCountry",
"daysTotalDuration" : 1.4894159098541704,
"loadPortBerthedAt" : "loadPortBerthedAt",
"loadPortDaysWaiting" : 9.301444243932576,
"loadBerthId" : 5,
"ballastCountry" : "ballastCountry",
"eta" : "eta",
"ballastCountryCode" : "ballastCountryCode",
"loadPortDaysBerthed" : 7.061401241503109,
"segment" : "segment",
"commodityGroup" : "commodityGroup",
"dischargeCountryCode" : "dischargeCountryCode",
"dischargePortDaysWaiting" : 1.2315135367772556,
"ballastPortUnlocode" : "ballastPortUnlocode",
"volume" : 1.4658129805029452,
"dischargePortBerthedAt" : "dischargePortBerthedAt",
"daysSteaming" : 1.0246457001441578,
"voyageId" : "voyageId",
"dischargePortName" : "dischargePortName",
"loadPortId" : 5,
"vesselName" : "vesselName",
"status" : "status",
"dwt" : 6.027456183070403,
"commodity" : "commodity",
"dischargeBerthId" : 2,
"parceling" : true,
"ballastPortName" : "ballastPortName",
"dischargePortDaysBerthed" : 7.386281948385884,
"distanceCalculated" : 6.84685269835264,
"dischargePortDepartedAt" : "dischargePortDepartedAt",
"destination" : "destination",
"imo" : 0,
"dischargePortUnberthedAt" : "dischargePortUnberthedAt",
"loadPortDaysTotal" : 2.3021358869347655,
"dischargePortArrivedAt" : "dischargePortArrivedAt",
"ballastPortId" : 1,
"loadCountry" : "loadCountry",
"dischargeRegion" : "dischargeRegion",
"flowId" : "flowId",
"loadPortName" : "loadPortName",
"loadBerthName" : "loadBerthName",
"loadPortUnlocode" : "loadPortUnlocode",
"dischargePortDaysTotal" : 4.145608029883936,
"dischargePortUnlocode" : "dischargePortUnlocode",
"loadPortDepartedAt" : "loadPortDepartedAt",
"dischargePortId" : 3,
"distanceActual" : 7.457744773683766,
"loadRegion" : "loadRegion",
"ballastRegion" : "ballastRegion",
"loadPortArrivedAt" : "loadPortArrivedAt",
"dischargeBerthName" : "dischargeBerthName",
"commodityValue" : "commodityValue",
"loadCountryCode" : "loadCountryCode"
}, {
"loadPortUnberthedAt" : "loadPortUnberthedAt",
"ballastStartedAt" : "ballastStartedAt",
"subSegment" : "subSegment",
"dischargeCountry" : "dischargeCountry",
"daysTotalDuration" : 1.4894159098541704,
"loadPortBerthedAt" : "loadPortBerthedAt",
"loadPortDaysWaiting" : 9.301444243932576,
"loadBerthId" : 5,
"ballastCountry" : "ballastCountry",
"eta" : "eta",
"ballastCountryCode" : "ballastCountryCode",
"loadPortDaysBerthed" : 7.061401241503109,
"segment" : "segment",
"commodityGroup" : "commodityGroup",
"dischargeCountryCode" : "dischargeCountryCode",
"dischargePortDaysWaiting" : 1.2315135367772556,
"ballastPortUnlocode" : "ballastPortUnlocode",
"volume" : 1.4658129805029452,
"dischargePortBerthedAt" : "dischargePortBerthedAt",
"daysSteaming" : 1.0246457001441578,
"voyageId" : "voyageId",
"dischargePortName" : "dischargePortName",
"loadPortId" : 5,
"vesselName" : "vesselName",
"status" : "status",
"dwt" : 6.027456183070403,
"commodity" : "commodity",
"dischargeBerthId" : 2,
"parceling" : true,
"ballastPortName" : "ballastPortName",
"dischargePortDaysBerthed" : 7.386281948385884,
"distanceCalculated" : 6.84685269835264,
"dischargePortDepartedAt" : "dischargePortDepartedAt",
"destination" : "destination",
"imo" : 0,
"dischargePortUnberthedAt" : "dischargePortUnberthedAt",
"loadPortDaysTotal" : 2.3021358869347655,
"dischargePortArrivedAt" : "dischargePortArrivedAt",
"ballastPortId" : 1,
"loadCountry" : "loadCountry",
"dischargeRegion" : "dischargeRegion",
"flowId" : "flowId",
"loadPortName" : "loadPortName",
"loadBerthName" : "loadBerthName",
"loadPortUnlocode" : "loadPortUnlocode",
"dischargePortDaysTotal" : 4.145608029883936,
"dischargePortUnlocode" : "dischargePortUnlocode",
"loadPortDepartedAt" : "loadPortDepartedAt",
"dischargePortId" : 3,
"distanceActual" : 7.457744773683766,
"loadRegion" : "loadRegion",
"ballastRegion" : "ballastRegion",
"loadPortArrivedAt" : "loadPortArrivedAt",
"dischargeBerthName" : "dischargeBerthName",
"commodityValue" : "commodityValue",
"loadCountryCode" : "loadCountryCode"
} ],
"nextToken" : "nextToken",
"csv" : "csv",
"prevToken" : "prevToken"
}
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. v3GetTradeFlowsResponse
default
An unexpected error response. rpcStatus
post /v3/tradeflows/tradelanemetrics
(getTradeLaneMetrics)
GetTradeflowModelVoyage gets trade flow model voyage values by grouping
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3TradeFlowDataRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"groupingVariable" : "groupingVariable",
"tradeLaneMetrics" : [ {
"avgVoyageDurationsDays" : 7.061401241503109,
"sumOfVolume" : 5.025004791520295,
"uniqueVessels" : 9,
"avgDischargePortDaysWaiting" : 5.637376656633329,
"medianDischargePortDaysWaiting" : 1.4894159098541704,
"avgVolume" : 3.616076749251911,
"medianVolume" : 7.457744773683766,
"avgDaysAtSea" : 6.027456183070403,
"avgSpeed" : 9.301444243932576,
"medianDistanceNm" : 1.1730742509559433,
"uniqueLoadPorts" : 9,
"avgDischargePortDaysBerthed" : 2.3021358869347655,
"medianDischargePortDaysBerthed" : 6.84685269835264,
"medianLoadPortDaysBerthed" : 1.0246457001441578,
"medianLoadPortDaysWaiting" : 1.2315135367772556,
"numberOfVoyages" : 4,
"avgDistanceCalculatedNm" : 4.145608029883936,
"medianDaysAtSea" : 7.386281948385884,
"avgLoadPortDaysWaiting" : 1.4658129805029452,
"avgLoadPortDaysBerthed" : 5.962133916683182,
"avgDistanceNm" : 2.027123023002322,
"uniqueDischargePorts" : 6,
"group" : "group"
}, {
"avgVoyageDurationsDays" : 7.061401241503109,
"sumOfVolume" : 5.025004791520295,
"uniqueVessels" : 9,
"avgDischargePortDaysWaiting" : 5.637376656633329,
"medianDischargePortDaysWaiting" : 1.4894159098541704,
"avgVolume" : 3.616076749251911,
"medianVolume" : 7.457744773683766,
"avgDaysAtSea" : 6.027456183070403,
"avgSpeed" : 9.301444243932576,
"medianDistanceNm" : 1.1730742509559433,
"uniqueLoadPorts" : 9,
"avgDischargePortDaysBerthed" : 2.3021358869347655,
"medianDischargePortDaysBerthed" : 6.84685269835264,
"medianLoadPortDaysBerthed" : 1.0246457001441578,
"medianLoadPortDaysWaiting" : 1.2315135367772556,
"numberOfVoyages" : 4,
"avgDistanceCalculatedNm" : 4.145608029883936,
"medianDaysAtSea" : 7.386281948385884,
"avgLoadPortDaysWaiting" : 1.4658129805029452,
"avgLoadPortDaysBerthed" : 5.962133916683182,
"avgDistanceNm" : 2.027123023002322,
"uniqueDischargePorts" : 6,
"group" : "group"
} ],
"numberOfGroups" : 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. v3GetTradeLaneMetricsResponse
default
An unexpected error response. rpcStatus
VesselService
post /v3/vessels/ais-report
(getAisSummary)
Generates summary data regarding AIS received during a specific requested period for a single vessel
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetAisSummaryRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"distanceTraveledNm" : 0.8008281904610115,
"initialTimestampForPeriod" : "2000-01-23T04:56:07.000+00:00",
"numberOfPositions" : 1,
"averageSpeedKnots" : 6.027456183070403,
"lastTimestampForPeriod" : "2000-01-23T04:56:07.000+00:00"
}
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. v3GetAisSummaryResponse
default
An unexpected error response. rpcStatus
post /v3/vessels/stoppageevents
(listStoppageEvents)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3ListStoppageEventsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"csv" : "csv",
"stoppageEvents" : [ {
"durationHours" : 5.637376656633329,
"endedAt" : "endedAt",
"minSpeedObserved" : 5.962133916683182,
"startedAt" : "startedAt",
"zoneId" : 1,
"imo" : 0,
"lon" : 7.061401241503109,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 6,
"classification" : "classification",
"lat" : 2.3021358869347655
}, {
"durationHours" : 5.637376656633329,
"endedAt" : "endedAt",
"minSpeedObserved" : 5.962133916683182,
"startedAt" : "startedAt",
"zoneId" : 1,
"imo" : 0,
"lon" : 7.061401241503109,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 6,
"classification" : "classification",
"lat" : 2.3021358869347655
} ]
}
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. v3ListStoppageEventsResponse
default
An unexpected error response. rpcStatus
post /v3/vessels/listvessels
(listVessels)
Vessels gets a list of vessels for the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3ListVesselsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"csv" : "csv",
"vessels" : [ {
"lastPositionReceived" : "lastPositionReceived",
"dwt" : 1.4658129805029452,
"mmsi" : 6,
"berthId" : 7,
"subSegment" : "subSegment",
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"portName" : "portName",
"ladenStatus" : "ladenStatus",
"navigationalStatus" : 2,
"portId" : 5,
"berthName" : "berthName",
"speed" : 4.145608029883936,
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"cargoStatus" : "cargoStatus",
"eta" : "eta",
"segment" : "segment",
"shipyardId" : 9,
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"direction" : "direction",
"commodityGroup" : "commodityGroup",
"destinationRegion" : "destinationRegion",
"lastStaticReceived" : "lastStaticReceived",
"anchorageId" : 2,
"anchorageName" : "anchorageName",
"lastPortName" : "lastPortName",
"lastCountryCode" : "lastCountryCode",
"lastRegion" : "lastRegion",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"commodityName" : "commodityName"
}, {
"lastPositionReceived" : "lastPositionReceived",
"dwt" : 1.4658129805029452,
"mmsi" : 6,
"berthId" : 7,
"subSegment" : "subSegment",
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"portName" : "portName",
"ladenStatus" : "ladenStatus",
"navigationalStatus" : 2,
"portId" : 5,
"berthName" : "berthName",
"speed" : 4.145608029883936,
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"cargoStatus" : "cargoStatus",
"eta" : "eta",
"segment" : "segment",
"shipyardId" : 9,
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"direction" : "direction",
"commodityGroup" : "commodityGroup",
"destinationRegion" : "destinationRegion",
"lastStaticReceived" : "lastStaticReceived",
"anchorageId" : 2,
"anchorageName" : "anchorageName",
"lastPortName" : "lastPortName",
"lastCountryCode" : "lastCountryCode",
"lastRegion" : "lastRegion",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"commodityName" : "commodityName"
} ]
}
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. v3ListVesselsResponse
default
An unexpected error response. rpcStatus
VesselStateService
post /v3/vessel-states
(getVesselStates)
Returns historical vessel states for the given dates and imo numbers supplied.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetVesselStatesRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselStates" : [ {
"predictedDestinationPortId" : 7,
"predictedDestinationScore" : 1.2315135367772556,
"subSegment" : "subSegment",
"lastVisitedPortId" : 6,
"portId" : 5,
"destinationScore" : 4.145608029883936,
"lastVisitedPortName" : "lastVisitedPortName",
"berthName" : "berthName",
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"eta" : "eta",
"segment" : "segment",
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"predictedDestinationPortName" : "predictedDestinationPortName",
"ladenStatusModel" : "ladenStatusModel",
"commodityGroup" : "commodityGroup",
"lastOpsPortName" : "lastOpsPortName",
"lastOpsPortId" : 7,
"anchorageName" : "anchorageName",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"dwt" : 1.4658129805029452,
"volumeOnBoard" : 1.1730742509559433,
"mmsi" : 6,
"destinationPortId" : 2,
"berthId" : 7,
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"navigationalStatus" : "navigationalStatus",
"speedStatus" : "speedStatus",
"predictedDestinationCountryCode" : "predictedDestinationCountryCode",
"shipyardId" : 9,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"hoursCarriedForward" : 4,
"timestamp" : "timestamp",
"direction" : "direction",
"predictedDestinationRegion" : "predictedDestinationRegion",
"destinationRegion" : "destinationRegion",
"commodityId" : 1,
"anchorageId" : 2,
"vesselType" : "vesselType",
"navigationalStatusCode" : 1,
"commodityName" : "commodityName"
}, {
"predictedDestinationPortId" : 7,
"predictedDestinationScore" : 1.2315135367772556,
"subSegment" : "subSegment",
"lastVisitedPortId" : 6,
"portId" : 5,
"destinationScore" : 4.145608029883936,
"lastVisitedPortName" : "lastVisitedPortName",
"berthName" : "berthName",
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"eta" : "eta",
"segment" : "segment",
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"predictedDestinationPortName" : "predictedDestinationPortName",
"ladenStatusModel" : "ladenStatusModel",
"commodityGroup" : "commodityGroup",
"lastOpsPortName" : "lastOpsPortName",
"lastOpsPortId" : 7,
"anchorageName" : "anchorageName",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"dwt" : 1.4658129805029452,
"volumeOnBoard" : 1.1730742509559433,
"mmsi" : 6,
"destinationPortId" : 2,
"berthId" : 7,
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"navigationalStatus" : "navigationalStatus",
"speedStatus" : "speedStatus",
"predictedDestinationCountryCode" : "predictedDestinationCountryCode",
"shipyardId" : 9,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"hoursCarriedForward" : 4,
"timestamp" : "timestamp",
"direction" : "direction",
"predictedDestinationRegion" : "predictedDestinationRegion",
"destinationRegion" : "destinationRegion",
"commodityId" : 1,
"anchorageId" : 2,
"vesselType" : "vesselType",
"navigationalStatusCode" : 1,
"commodityName" : "commodityName"
} ]
}
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. v3VesselStatesResponse
default
An unexpected error response. rpcStatus
post /v3/vessel-states-for-date
(getVesselStatesForDate)
Returns all historical states for the entire fleet for a single date.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetVesselStatesForDateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselStates" : [ {
"predictedDestinationPortId" : 7,
"predictedDestinationScore" : 1.2315135367772556,
"subSegment" : "subSegment",
"lastVisitedPortId" : 6,
"portId" : 5,
"destinationScore" : 4.145608029883936,
"lastVisitedPortName" : "lastVisitedPortName",
"berthName" : "berthName",
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"eta" : "eta",
"segment" : "segment",
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"predictedDestinationPortName" : "predictedDestinationPortName",
"ladenStatusModel" : "ladenStatusModel",
"commodityGroup" : "commodityGroup",
"lastOpsPortName" : "lastOpsPortName",
"lastOpsPortId" : 7,
"anchorageName" : "anchorageName",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"dwt" : 1.4658129805029452,
"volumeOnBoard" : 1.1730742509559433,
"mmsi" : 6,
"destinationPortId" : 2,
"berthId" : 7,
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"navigationalStatus" : "navigationalStatus",
"speedStatus" : "speedStatus",
"predictedDestinationCountryCode" : "predictedDestinationCountryCode",
"shipyardId" : 9,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"hoursCarriedForward" : 4,
"timestamp" : "timestamp",
"direction" : "direction",
"predictedDestinationRegion" : "predictedDestinationRegion",
"destinationRegion" : "destinationRegion",
"commodityId" : 1,
"anchorageId" : 2,
"vesselType" : "vesselType",
"navigationalStatusCode" : 1,
"commodityName" : "commodityName"
}, {
"predictedDestinationPortId" : 7,
"predictedDestinationScore" : 1.2315135367772556,
"subSegment" : "subSegment",
"lastVisitedPortId" : 6,
"portId" : 5,
"destinationScore" : 4.145608029883936,
"lastVisitedPortName" : "lastVisitedPortName",
"berthName" : "berthName",
"ladenStatusDraught" : "ladenStatusDraught",
"relatedPortName" : "relatedPortName",
"eta" : "eta",
"segment" : "segment",
"destinationPortName" : "destinationPortName",
"zoneId" : 5,
"predictedDestinationPortName" : "predictedDestinationPortName",
"ladenStatusModel" : "ladenStatusModel",
"commodityGroup" : "commodityGroup",
"lastOpsPortName" : "lastOpsPortName",
"lastOpsPortId" : 7,
"anchorageName" : "anchorageName",
"shipyardName" : "shipyardName",
"vesselName" : "vesselName",
"dwt" : 1.4658129805029452,
"volumeOnBoard" : 1.1730742509559433,
"mmsi" : 6,
"destinationPortId" : 2,
"berthId" : 7,
"destination" : "destination",
"destinationCountryCode" : "destinationCountryCode",
"imo" : 0,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"navigationalStatus" : "navigationalStatus",
"speedStatus" : "speedStatus",
"predictedDestinationCountryCode" : "predictedDestinationCountryCode",
"shipyardId" : 9,
"zoneName" : "zoneName",
"relatedPortId" : 3,
"portCallStatus" : "portCallStatus",
"hoursCarriedForward" : 4,
"timestamp" : "timestamp",
"direction" : "direction",
"predictedDestinationRegion" : "predictedDestinationRegion",
"destinationRegion" : "destinationRegion",
"commodityId" : 1,
"anchorageId" : 2,
"vesselType" : "vesselType",
"navigationalStatusCode" : 1,
"commodityName" : "commodityName"
} ]
}
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. v3VesselStatesResponse
default
An unexpected error response. rpcStatus
Models
[ Jump to Methods ]
Table of Contents
Request object for adding a Vessel to a Fleet - Request object for adding a Vessel to a Fleet
Request object for renaming a Fleet - Request object for renaming a Fleet
Request object for updating a vessel - Request object for updating a vessel
v3BatchDistanceRequest - Request object for BatchCalculateDistance method
v3BatchDistanceResponse - Response object for BatchCalculateDistance method
v3CustomPolygonRequest - Request object for GetPolygonCounts
v3CustomPolygonResponse - Response object for GetPolygonCounts
v3DistanceRequest - Request object for CalculateDistance method
v3FleetGrowthTimeseriesGroup - Fleet growth timeseries group
v3GetAisSummaryRequest - Request object for GetAisSummaryRequest
v3GetAisSummaryResponse - Request object for GetAisSummaryResponse
v3GetFleetListRequest - Request object for parsing a file into a fleet
v3GetFleetLiveMapResponse - GetFleetLiveMapRequest request object for getting static fleet map
v3GetPortCallTimeseriesResponse - Response object for port call timeseries queries
v3GetPortCallsResponse - Response object for port call queries
v3GetPortParticularsRequest - Request object for GetPortParticulars
v3GetPortParticularsResponse - Response object for GetPortParticulars
v3GetTonnageFleetGrowthResponse - Response object for GetTonnageFleetGrowth
v3GetTonnageFleetRequest - Request object for GetTonnageFleetStatus and GetTonnageFleetGrowth
v3GetTonnageFleetStatusResponse - Response object for GetTonnageFleetStatus
v3GetTonnageZoneChangesRequest - Request object for TonnageZoneChange
v3GetTonnageZoneChangesResponse - Response object for TonnageZoneChange
v3GetTonnageZoneCountResponse - Response object for tonnage zone counts
v3GetTradeFlowTimeseriesResponse - Response object for trade flow timeseries queries
v3GetTradeFlowsResponse - Response object for trade flow queries
v3GetVesselStatesForDateRequest - Request message for VesselStateService.GetVesselStatesForDate
v3GetVesselStatesRequest - Request message for VesselStateService.GetVesselStates
v3GetVesselsInPortRequest - Request object for GetVesselsInPort
v3GetVesselsInPortResponse - Response object for GetVesselsInPort
v3TonnageChineseWatersRequest - Request object for TonnageChineseWaters
v3TonnageChineseWatersResponse - Response object for TonnageChineseWaters
v3TonnageTimeseriesGroup - Tonnage zone/fleet speed timeseries group
v3UpdateVesselParams - Parameter object for updating a vessel in a Fleet
v3ZoneChangesTimeseriesGroup - Tonnage zone/fleet speed timeseries group
DistanceResponseDistanceAlgorithmStatus Up
GetAisSummaryRequestResolution Up
Request object for adding a Vessel to a Fleet - Request object for adding a Vessel to a Fleet Up
vessel (optional)
Request object for batch adding Vessels to a Fleet - Request object for batch adding Vessels to a Fleet Up
vessels (optional)
array[v3VesselParams] List of Vessels to be added.
Request object for batch adding Vessels to a Fleet_1 - Request object for batch adding Vessels to a Fleet Up
vessels (optional)
array[v3VesselParams] List of Vessels to be added.
Request object for renaming a Fleet - Request object for renaming a Fleet Up
newFleetName (optional)
String The new name of the Fleet.
Request object for updating a vessel - Request object for updating a vessel Up
vessel (optional)
upsert (optional)
Boolean Flag indicating whether the vessel should be created if it doesnt not already exist. If the upsert flag is set to false, and a vessel does not already exist, the function will return an error.
distancecalculatorv3Location Up
Locatation data object. Locations can be specified using either raw lon/lat coordinates, unlocodes, Oceanbolt portIds or by specifying IMO number of a vessel. If an IMO is specified, routing will be calculated from the vessels current location.
imo (optional)
Long IMO number to include in the routing calculation. The current location of the vessel will be used in routing calculations. format: int64
unlocode (optional)
String UNLOCODE of a port to be included in routing calculation.
point (optional)
portId (optional)
Long Oceanbolt port identifier to be included in routing calculation. format: int64
filtersVesselFilter Up
imo (optional)
array[Long] List IMO values to filter on. Example: [1234567,7654321]. format: int64
dwt (optional)
array[Double] DWT range to filter on. Example: [45000,90000] (both values inclusive). format: double
maxDraught (optional)
array[Double] Maximum Draught range to filter on (value in meters). Example: [12,20] (both values inclusive). format: double
loa (optional)
array[Double] LOA range to filter on (value in meters). Example: [150,200] (both values inclusive). format: double
beam (optional)
array[Double] BEAM range to filter on (value in meters). Example: [10,40] (both values inclusive). format: double
logFitted (optional)
Boolean Flag to specify filtering on whether a vessel is log fitted or not. If left blank, filter will not be applied.
selfUnloader (optional)
Boolean Flag to specify filtering on whether a vessel is classified as a self unloader or not. If left blank, filter will not be applied.
geared (optional)
Boolean Flag to specify filtering on whether a vessel is geared or not. If left blank, filter will not be applied.
iceClassed (optional)
Boolean Flag to specify filtering on whether a vessel is ice classed or not. If left blank, filter will not be applied.
mpv (optional)
Boolean Flag to specify filtering on whether a vessel is classified as an MPV. If left blank, filter will not be applied.
gt (optional)
array[Double] GT range to filter on. Example: [45000,90000] (both values inclusive). format: double
grainCapacity (optional)
array[Double] Grain capacity range to filter on (value in cubic meters). Example: [45000,90000] (both values inclusive). format: double
gasCapacityCbm (optional)
array[Double] Gas capacity range filter on (value in cubic meters). Example: [45000,90000] (both values inclusive). format: double
built (optional)
array[Integer] Built year range to filter on. Example: [1998,2005] (both values inclusive). format: int32
vesselType (optional)
array[String] List of vessel type values to filter on. Example: TBD.
flagState (optional)
array[String] List of flag state values to filter on. Example: [US,CN].
layerId_batchaddpolygons_body Up
polygons (optional)
upsert (optional)
layerId_renamelayer_body Up
newLayerName (optional)
layerId_replacepolygons_body Up
polygons (optional)
upsert (optional)
protobufAny Up
rpcStatus Up
code (optional)
Integer format: int32
message (optional)
details (optional)
v3AggregationGroup Up
group (optional)
String Name of the aggregation group.
rows (optional)
array[v3AggregationRow] List of categories within the group.
v3AggregationRow Up
category (optional)
String Category name for the aggregation row.
value (optional)
Double Value of the aggregation row. format: double
v3AisQualityResponse Up
vesselSegmentsByTime (optional)
zonesByTime (optional)
zonesBySegment (optional)
v3AnchorageStay - AnchorageStay object Up
anchorageId (optional)
Long format: int64
anchorageName (optional)
arrivedAt (optional)
departedAt (optional)
hoursInAnchorage (optional)
Double The duration of the stay in the anchorage in hours. format: double
v3BatchDistanceRequest - Request object for BatchCalculateDistance method Up
requests (optional)
v3BatchDistanceResponse - Response object for BatchCalculateDistance method Up
responses (optional)
v3BerthStay - BerthStay object Up
berthId (optional)
Long format: int64
berthName (optional)
berthType (optional)
arrivedAt (optional)
departedAt (optional)
draughtIn (optional)
Double format: double
draughtOut (optional)
Double format: double
hoursInBerth (optional)
Double The duration of the stay in the berth in hours. format: double
v3BoundingBox Up
lowerLeft (optional)
array[Double] format: double
upperRight (optional)
array[Double] format: double
v3ChineseWatersTimeseriesGroup Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3ChineseWatersTimeseriesRow] Rows of timeseries data.
v3ChineseWatersTimeseriesRow Up
date (optional)
String UTC date timestamp of the timeseries row.
insideChineseWatersCount (optional)
Integer Number of Chinese flagged vessels inside Chinese waters. format: int32
insideChineseWatersDwt (optional)
Double Sum of DWT of Chinese flagged vessels inside Chinese waters. format: double
outsideChineseWatersCount (optional)
Integer Number of Chinese flagged vessels outside Chinese waters. format: int32
outsideChineseWatersDwt (optional)
Double Sum of DWT of Chinese flagged vessels outside Chinese waters. format: double
v3Commodity Up
commodity (optional)
commodityId (optional)
Integer format: int32
commodityValue (optional)
commodityGroup (optional)
platform (optional)
v3CongestionResponse Up
Congestion responseobject.
numberOfCurrentVessels (optional)
Integer Number of vessels currently congested. format: int32
currentTopPorts (optional)
array[v3CongestionSplitRow] List of top ports by amount of congested.
currentTopSubSegments (optional)
array[v3CongestionSplitRow] List of top segments by amount of congested.
currentTopCommodityGroups (optional)
array[v3CongestionSplitRow] List of top commodities by amount of congested.
currentTopLoadCountries (optional)
array[v3CongestionSplitRow] List of top countries by amount of congested.
timeseriesDefault (optional)
currentVessels (optional)
array[v3CongestionStay] List of vessels currently congested.
timeseries (optional)
array[v3CongestionTimeseriesGroup] Congestion timeseries response.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3CongestionSplitRow Up
item (optional)
count (optional)
Integer format: int32
dwt (optional)
Double format: double
countPercent (optional)
Double format: double
dwtPercent (optional)
Double format: double
v3CongestionStay Up
imo (optional)
Integer IMO number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
segment (optional)
String The vessel segment (handysize, supramax, panamax etc.).
subSegment (optional)
String The vessel sub segment (large capesize, kamsarmax, vloc etc.).
dwt (optional)
Double The DWT of the vessel. format: double
currentPortId (optional)
String The Oceanbolt port id where the vessel is currently congested.
currentPortName (optional)
String The name of the port where the vessel is currently congested.
currentCountry (optional)
String The name of the country where the vessel is currently congested.
currentCountryCode (optional)
String The 2-letter ISO code of the country where the vessel is currently congested.
arrivedAt (optional)
String The UTC timestamp of when the vessel arrived at the current port.
waitingTimeDays (optional)
Double The waiting time in days that the vessel has waiting up until today. format: double
lastLoadCountry (optional)
String The name of the country where the vessel loaded its prior cargo.
lastLoadCountryCode (optional)
String The 2-letter ISO code of the country where the vessel loaded its prior cargo.
lastLoadPortName (optional)
String The name of the port where the vessel loaded its prior cargo.
lastLoadBerthName (optional)
String The name of the terminal where the vessel loaded its prior cargo.
lastPortDepartedAt (optional)
String The UTC timestamp of when the vessel departed its prior load port.
lastLoadPortId (optional)
Integer The Oceanbolt port id of the port where the vessel loaded its prior cargo. format: int32
commodityGroup (optional)
String Name of the commodity group.
commodity (optional)
String Name of the commodity.
volume (optional)
Double Volume of the cargo onboard the vessel. format: double
lat (optional)
Double Not implemented. format: double
lng (optional)
Double Not implemented. format: double
course (optional)
Double Not implemented. format: double
speed (optional)
Double Not implemented. format: double
ladenStatus (optional)
String Current laden status of the vessel (laden or ballast).
v3CongestionTimeseriesGroup Up
Congestion timeseries group object.
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3CongestionTimeseriesRow] Rows of timeseries data.
v3CongestionTimeseriesRow Up
Congestion timeseries row object.
date (optional)
String UTC date timestamp of the timeseries row.
vesselCount (optional)
Integer Number of vessels that were congested on the date. format: int32
vesselDwt (optional)
Double Sum of DWT that were congested on the date. format: double
avgWaitingDays (optional)
Double Average waiting days of vessels that were congested on the date. format: double
medianWaitingDays (optional)
Double Median waiting days of vessels that were congested on the date. format: double
v3Country Up
country (optional)
countryCode (optional)
v3CreateFleetRequest - Request object for creating a Fleet Up
fleetName (optional)
String The new name of the Fleet.
v3CreateLayerRequest Up
layerName (optional)
v3CustomPolygonRequest - Request object for GetPolygonCounts Up
geojson (optional)
ladenStatus (optional)
segment (optional)
subSegment (optional)
startDate (optional)
endDate (optional)
v3CustomPolygonResponse - Response object for GetPolygonCounts Up
timeseries (optional)
v3DistanceRequest - Request object for CalculateDistance method Up
locations (optional)
array[distancecalculatorv3Location] List of locations to calculate the shortest route between. If more than 2 locations are specified, then routing will be calculated through all locations, using intermediary locations as waypoints. The routing order of the locations will be based on the order of the locations in the request body.
speed (optional)
Double An optional speed parameter. If this is supplied, then the API will return an estimate of the total duration of the voyage, based on the supplied speed. Speed parameter should be supplied in knots. format: double
transform (optional)
String Specifies a transformation to be applied to the returned shortest path. Allowed values are [great_circle].
longitudeAdjustment (optional)
String Specifies whether the resulting points/lines crossing the antimeridian should be adjusted to form a continuous line for plotting. Allowed values are [antimeridian,none]. Default value is 'antimeridian.
blockSuez (optional)
blockPanama (optional)
v3DistanceResponse Up
totalDistance (optional)
Double Total distance of the entire voyage in nautical miles. format: double
totalDurationHours (optional)
Double Total expected duration of the entire voyage, given a certain speed supplied by the user. format: double
totalShortestPath (optional)
array[v3Point] The calculated shortest path between the start/end point of the entire voyage.
individualLegs (optional)
status (optional)
DistanceResponseDistanceAlgorithmStatus
v3DryDockResponse Up
DryDock responseobject.
numberOfCurrentVessels (optional)
Integer format: int32
currentTopPorts (optional)
currentTopSubSegments (optional)
currentTopCountries (optional)
currentTopShipyards (optional)
timeseriesDefault (optional)
currentVessels (optional)
array[v3DryDockStay] List of vessels currently congested.
timeseries (optional)
array[v3DryDockTimeseriesGroup] DryDock timeseries response.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3DryDockSplitRow Up
item (optional)
count (optional)
Integer format: int32
dwt (optional)
Double format: double
countPercent (optional)
Double format: double
dwtPercent (optional)
Double format: double
v3DryDockStay Up
imo (optional)
Integer IMO number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
segment (optional)
String The vessel segment (handysize, supramax, panamax etc.).
subSegment (optional)
String The vessel sub segment (large capesize, kamsarmax, vloc etc.).
dwt (optional)
Double The DWT of the vessel. format: double
portId (optional)
Integer The Oceanbolt port id where the vessel is currently docked. format: int32
portName (optional)
String The name of the port where the vessel is currently docked.
shipyardId (optional)
Integer The Oceanbolt shipyard id where the vessel is currently docked. format: int32
shipyardName (optional)
String The name of the shipyard where the vessel is currently docked.
countryName (optional)
String The name of the country where the vessel is currently docked.
countryCode (optional)
String The 2-letter ISO code of the country where the vessel is currently docked.
currentCountryCode (optional)
arrivedAt (optional)
String The UTC timestamp of when the vessel arrived at the current port.
waitingTimeDays (optional)
Double The duration in days that the vessel has been dry docked up until today. format: double
lat (optional)
Double Not implemented. format: double
lng (optional)
Double Not implemented. format: double
course (optional)
Double Not implemented. format: double
speed (optional)
Double Not implemented. format: double
v3DryDockTimeseriesGroup Up
DryDock timeseries group object.
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
v3DryDockTimeseriesRow Up
DryDock timeseries row object.
date (optional)
vesselCount (optional)
Integer format: int32
vesselDwt (optional)
Double format: double
avgWaitingDays (optional)
Double format: double
medianWaitingDays (optional)
Double format: double
v3EmptyResponse - Empty response object Up
v3EmptyResponse1 Up
v3Fleet - Fleet resource Up
fleetId (optional)
String The Fleet identifier.
fleetName (optional)
String The name of the Fleet.
platform (optional)
ownerUserId (optional)
String The user id of the Fleet owner (the user who has created the Fleet).
organization (optional)
String The organization that the user belongs to.
vesselsInFleet (optional)
Integer The number of vessels in the Fleet. format: int32
vessels (optional)
array[v3Vessel1] List of Vessels in the Fleet.
sharedWithOrg (optional)
Boolean A flag indicating whether this is a shared fleet.
v3FleetGrowthTimeseriesGroup - Fleet growth timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3FleetGrowthTimeseriesRow] Rows of timeseries data.
v3FleetGrowthTimeseriesRow - Fleet growth timeseries row Up
date (optional)
String UTC date timestamp of the timeseries row.
scrapped (optional)
Double Number of vessels (or sum of DWT) that was scrapped during this period. format: double
delivered (optional)
Double Number of vessels (or sum of DWT) that was delivered during this period. format: double
net (optional)
Double Net number of vessels (or sum of DWT) that was added to/removed from the fleet during this period. format: double
v3Fleets - Response object for listing Fleets Up
fleets (optional)
array[v3Fleet] List of user defined Fleet resources.
organizationFleets (optional)
array[v3Fleet] List of organizational Fleet resources that are shared with the current user.
predefinedFleets (optional)
array[v3Fleet] List of system level predefined Fleet resources.
v3GeoPoint Up
lat (optional)
Double Latitude. format: double
lon (optional)
Double Longitude. format: double
v3GetAisSummaryRequest - Request object for GetAisSummaryRequest Up
imo (optional)
Long format: int64
startTime (optional)
Date format: date-time
endTime (optional)
Date format: date-time
resolution (optional)
GetAisSummaryRequestResolution
v3GetAisSummaryResponse - Request object for GetAisSummaryResponse Up
distanceTraveledNm (optional)
Double format: double
averageSpeedKnots (optional)
Double format: double
numberOfPositions (optional)
Long format: int64
initialTimestampForPeriod (optional)
Date format: date-time
lastTimestampForPeriod (optional)
Date format: date-time
v3GetCongestionRequest Up
Congestion request object.
portId (optional)
array[Integer] List of Oceanbolt port ids to filter on. This filters on the port where the vessel is currently congested. format: int32
portUnlocode (optional)
array[String] List of five letter UNLOCODEs for to filter on.
countryCode (optional)
array[String] The list of 2-letter ISO countries to get congestion data for. This filters on the country where the vessel is currently congested. Country code can be obtained either from the /entities/countries endpoint.
regionId (optional)
array[String] The list of regionIds to get congestion data for. This filters on the region where the vessel is currently congested. Region Id can be obtained either from the /entities/regions endpoint.
operation (optional)
array[String] List of port call operation types to filter on. Allowed values are: **["load","discharge";"yard","unknown"].
commodity (optional)
array[String] List of commodities to get data for (get a list of all commodities from <strong>/entities/commodities</strong>).
commodityGroup (optional)
array[String] List of commodity groups to get data for (get a list of all commodity groups from <strong>/entities/commodities</strong>).
ladenStatus (optional)
array[String] Laden status to filter on. Allowed values are ['laden', 'ballast'].
imo (optional)
array[Integer] List of IMO numbers to include in the congestion data results. format: int32
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
groupBy (optional)
String Determines the grouping of the timeseries data. This parameter only applies to the <strong>/portcalls/timeseries</strong> endpoint.
frequency (optional)
String Not implemented.
lastLoadCountryCode (optional)
array[String] The list of 2-letter ISO countries to get congestion data for. This filters on the country where the vessel loaded its prior cargo. Country code can be obtained either from the /entities/countries endpoint.
lastLoadPortId (optional)
array[Integer] List of Oceanbolt port ids to filter on. This filters on the ports where the vessel loaded its prior cargo. format: int32
exclude (optional)
Integer Specifies whether to exclude congestion stays that have a longer duration than N (in days). For example if a value of <code>exlude=60</code>'` is specified then all congestion stays that lasted longer than 60 days will be excluded from the returned data. format: int32
maxStayLength (optional)
Integer Specifies whether to exclude congestion stays that have a longer duration than N (in days). For example if a value of <code>max_stay_length=60</code>'` is specified then all congestion stays that lasted longer than 60 days will be excluded from the returned data. format: int32
includeVesselsCurrentlyAtBerth (optional)
Boolean Flag to indicate whether vessels that are currently at berth should be included in congestion statistics.
includeVesselsPreviouslyBerthed (optional)
Boolean Flag to indicate whether vessels that have already visited a berth (but are not currently in a berth) as part of the current Port Call should be included in congestion statistics.
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
lastNDays (optional)
Integer Short hand parameter for quickly getting data for the last N days. Cannot be supplied along either start_date or end_date. format: int32
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
displayDate (optional)
String Parameter used to display historical vessel lists for congested vessels. It is only applicable to the CongestionVessels method.
dwt (optional)
array[Double] DWT range to filter on. Example: [60000,90000] - this would filter only to only include dwt between 60k and 90k (both values inclusive). format: double
vesselFilter (optional)
v3GetCorruptPortCallsRequest Up
Corrupt port call request object.
imo (optional)
array[Long] List of IMO numbers of the specified vessels. format: int64
startDate (optional)
String Start of port call date range.
endDate (optional)
String End of port call date range.
v3GetCorruptPortCallsResponse Up
Corrupt port call response object.
visits (optional)
array[v3PortCallVisits] List of PortCallVisits summarizing number of port calls per country.
v3GetDryDockRequest Up
DryDock request object.
portId (optional)
array[Integer] List of Oceanbolt port ids to filter on. This filters on the port where the vessel is currently in dry dock. format: int32
portUnlocode (optional)
array[String] List of five letter UNLOCODEs for to filter on.
shipyardId (optional)
array[Integer] List of Oceanbolt shipyard ids to filter on. This filters on the shipyard where the vessel is currently in dry dock. format: int32
countryCode (optional)
array[String] The list of 2-letter ISO countries to get congestion data for. This filters on the country where the vessel is currently congested. Country code can be obtained either from the /entities/countries endpoint.
regionId (optional)
array[String] The list of region IDs to get dry dock data for. Region ID can be obtained either from the /entities/regions endpoint.
segment (optional)
subSegment (optional)
groupBy (optional)
String Determines the grouping of the timeseries data. This parameter only applies to the <strong>/drydock/timeseries</strong> endpoint.
exclude (optional)
Integer 60 days will be excluded from the returned data. format: int32
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
startDate (optional)
endDate (optional)
lastNDays (optional)
Integer Short hand parameter for quickly getting data for the last N days. Cannot be supplied along either start_date or end_date. format: int32
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
displayDate (optional)
String Parameter used to display historical vessel lists for congested vessels. It is only applicable to the DryDockVessels method.
v3GetDryDockStaysRequest - DryDockstays Up
imo (optional)
array[Integer] List of unique vessel identifiers (IMO numbers). This allows filtering to show data only for a subset of vessels. Example: [1234567,7654321]. format: int32
portId (optional)
array[Integer] This filters on the port where the vessel is currently in dry dock. format: int32
shipyardId (optional)
array[Integer] List of Oceanbolt shipyard ids to filter on. format: int32
unlocode (optional)
array[String] UNLOCODE of the port.
segment (optional)
array[String] List of vessel segments to filter on.
subSegment (optional)
array[String] List of vessel sub segments to filter on.
startDate (optional)
endDate (optional)
latestOnly (optional)
Boolean Flat to indiciate whether only the latest port call should be included on an IMO basis. If this is enabled, only the latest port call for each imo passing the filter will be returned.
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
groupBy (optional)
String Determines the grouping of the timeseries data. This parameter only applies to the <strong>/drydock/timeseries</strong> endpoint.
v3GetDryDockStaysResponse Up
data (optional)
array[v3HistoricalDryDockStay]
csv (optional)
xlsx (optional)
previousToken (optional)
nextToken (optional)
maxResults (optional)
Integer format: int32
v3GetFleetListRequest - Request object for parsing a file into a fleet Up
fileName (optional)
file (optional)
byte[] format: byte
fleetId (optional)
fleetName (optional)
overwrite (optional)
v3GetFleetLiveMapResponse - GetFleetLiveMapRequest request object for getting static fleet map Up
mapImage (optional)
v3GetFleetSpeedResponse - Response object for FleetSpeed Up
timeseries (optional)
array[v3TonnageTimeseriesGroup] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetGlobalTonnageStatusResponse Up
globalTonnageZoneCounts (optional)
array[v3GlobalTonnageZoneCount]
csv (optional)
xlsx (optional)
v3GetLocationVolumeResponse Up
data (optional)
array[v3LocationVolume] List of locations.
v3GetMarineProtectedAreaStaysResponse Up
mpaStays (optional)
array[v3MarineProtectedAreaStay]
file (optional)
v3GetMarineProtectedAreaSummaryRequest Up
reportingPeriods (optional)
array[v3MpaReportingPeriodRequest]
format (optional)
v3GetMarineProtectedAreaSummaryResponse Up
summaryRows (optional)
mpaStays (optional)
array[v3MarineProtectedAreaStay]
file (optional)
v3GetPortCallTimeseriesResponse - Response object for port call timeseries queries Up
timeseries (optional)
array[v3TimeseriesGroup1] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetPortCallsRequest - Port calls data requests object. This is shared between all port calls queries Up
imo (optional)
array[Integer] List of unique vessel identifiers (IMO numbers). This allows filtering to show data only for a subset of vessels. Example: [1234567,7654321]. format: int32
portId (optional)
array[Integer] List of Oceanbolt port ids to filter on. format: int32
berthId (optional)
array[Integer] List of Oceanbolt berth ids to filter on. format: int32
unlocode (optional)
array[String] List of five letter UNLOCODEs of ports to filter on.
countryCode (optional)
array[String] List of two letter ISO country codes to filter on.
region (optional)
array[String] List of regions to filter on. Allowed values can be obtained from the <strong>/entities/regions</strong> endpoint.
basin (optional)
array[String] List of basins to filter on. Allowed values are: ["atlantic","indian_ocean","pacific_americas","pacific_asia"].
latestOnly (optional)
Boolean Flat to indiciate whether only the latest port call should be included on an IMO basis. If this is enabled, only the latest port call for each imo passing the filter will be returned.
nextToken (optional)
String The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
maxResults (optional)
Integer An optional limit for the number of resources returned in a single call. format: int32
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
commodity (optional)
array[String] List of commodities to get data for (get a list of all commodities from <strong>/entities/commodities</strong>).
commodityGroup (optional)
array[String] List of commodity groups to get data for (get a list of all commodity groups from <strong>/entities/commodities</strong>).
operation (optional)
array[String] List of port call operation types to filter on. Allowed values are: **["D","Dx";"L","Lx","B","Y","U"].
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
groupBy (optional)
String Determines the grouping of the timeseries data. This parameter only applies to the <strong>/portcalls/timeseries</strong> endpoint.
frequency (optional)
String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>["daily", "weekly", "monthly","quarterly "yearly"]</strong>. Default value is "monthly". This parameter only applies to the <strong>/portcalls/timeseries</strong> endpoint.
limitGroups (optional)
Boolean Flag to indicate whether grouped timeseries should be limited to top N entries. If the parameter is present, the endpoint will only return the top N groups, and the remaining entries will be grouped into others.
dwt (optional)
array[Double] DWT range to filter on. Example: [60000,90000] - this would filter only to only include dwt between 60k and 90k (both values inclusive). format: double
vesselFilter (optional)
v3GetPortCallsResponse - Response object for port call queries Up
prevToken (optional)
String Pagination token indicating the presence of additional previous results.
nextToken (optional)
String Pagination token indicating the presence of additional further results.
data (optional)
array[v3PortCall] List of port calls.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetPortParticularsRequest - Request object for GetPortParticulars Up
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
portId (optional)
Integer Oceanbolt port identifier to filter on. format: int32
berthId (optional)
Integer Oceanbolt berth identifier to filter on. format: int32
unlocode (optional)
String Unlocode port identifier to filter on.
lastNDays (optional)
Integer Alternative way of specifying date filter. If specified, then data will only be based on port calls in last X days. format: int32
v3GetPortParticularsResponse - Response object for GetPortParticulars Up
numberOfPortCalls (optional)
Integer Number of port calls which forms the basis of the statistical aggregates. format: int32
loa (optional)
beam (optional)
maxDraught (optional)
reportedDraught (optional)
dwt (optional)
airDraught (optional)
v3GetTonnageBasinRequest - GetTonnageBasin Up
basin (optional)
segment (optional)
subSegment (optional)
startDate (optional)
endDate (optional)
excludeMpv (optional)
lastNDays (optional)
Integer format: int32
format (optional)
v3GetTonnageBasinResponse Up
timeseries (optional)
array[v3TonnageTimeseriesGroup]
csv (optional)
xlsx (optional)
v3GetTonnageDataRequest Up
Request object for getting tonnage zone data and fleet speed data.
zoneId (optional)
array[Integer] List of zones ids to filter on. Allowed values can be obtained from the /entities/zones endpoint. format: int32
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
direction (optional)
array[String] The list of directions to get tonnage data for. The following directions are allowed: <strong>["NNE","ENE","ESE","SSE","SSW","WSW","WNW","NNW"]</strong>. Directions can also be obtained from the interactive direction selector found at app.oceanbolt.com.
ladenStatus (optional)
array[String] The laden status to get tonnage data for. The following values are allowed: <strong>["laden","ballast"]</strong>.
portStatus (optional)
array[String] The port status to get tonnage data for. The following values are allowed: <strong>["in_port","at_sea"]</strong>.
groupBy (optional)
excludeMpv (optional)
Boolean Flag to specify whether or not MPV vessels should be included/excluded. Default is to include.
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
lastNDays (optional)
Integer Short hand parameter for quickly getting data for the last N days. format: int32
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
v3GetTonnageFleetGrowthResponse - Response object for GetTonnageFleetGrowth Up
timeseries (optional)
array[v3FleetGrowthTimeseriesGroup] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTonnageFleetRequest - Request object for GetTonnageFleetStatus and GetTonnageFleetGrowth Up
frequency (optional)
String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>["daily", "weekly", "monthly","quarterly "yearly"]</strong>. Default value is "monthly".
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
groupBy (optional)
String Determines the grouping of the timeseries data.
metric (optional)
String The metric to retrieve for timeseries aggregations. Allowed values: ["count","dwt"]. Default is "count".
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
excludeMpv (optional)
Boolean Flag to specify whether or not MPV vessels should be included/excluded. Default is to include.
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
v3GetTonnageFleetStatusResponse - Response object for GetTonnageFleetStatus Up
timeseries (optional)
array[v3TimeseriesGroup2] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTonnageZoneChangesRequest - Request object for TonnageZoneChange Up
fromZoneId (optional)
array[Integer] format: int32
toZoneId (optional)
array[Integer] format: int32
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
ladenStatus (optional)
array[String] The laden status to get tonnage data for. The following values are allowed: <strong>["laden","ballast"]</strong>.
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
groupBy (optional)
String Determines the grouping of the timeseries data.
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
frequency (optional)
String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>["daily", "weekly", "monthly","quarterly "yearly"]</strong>. Default value is "monthly".
vesselFilter (optional)
v3GetTonnageZoneChangesResponse - Response object for TonnageZoneChange Up
timeseries (optional)
array[v3ZoneChangesTimeseriesGroup] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTonnageZoneCountResponse - Response object for tonnage zone counts Up
timeseries (optional)
array[v3TonnageTimeseriesGroup] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTradeFlowAggregationResponse Up
data (optional)
array[v3AggregationGroup] List of aggregation rows.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTradeFlowHistogramResponse Up
groupingVariable (optional)
String Name of the varible that results have been grouped by.
numberOfGroups (optional)
Integer The number of groups returned. format: int32
groups (optional)
array[v3HistogramGroup] List of histogram groups.
v3GetTradeFlowTimeseriesResponse - Response object for trade flow timeseries queries Up
timeseries (optional)
array[v3TimeseriesGroup3] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTradeFlowsResponse - Response object for trade flow queries Up
data (optional)
array[v3TradeFlow] List of trade flows.
nextToken (optional)
String Pagination token indicating the presence of additional further results.
prevToken (optional)
String Pagination token indicating the presence of additional previous results.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3GetTradeLaneMetricsResponse Up
groupingVariable (optional)
numberOfGroups (optional)
Integer format: int32
tradeLaneMetrics (optional)
v3GetVesselStatesForDateRequest - Request message for VesselStateService.GetVesselStatesForDate Up
date (optional)
v3GetVesselStatesRequest - Request message for VesselStateService.GetVesselStates Up
imo (optional)
array[Integer] format: int32
startDate (optional)
endDate (optional)
v3GetVesselsInPortRequest - Request object for GetVesselsInPort Up
portId (optional)
Long format: int64
unlocode (optional)
vesselFilter (optional)
timestamp (optional)
Date Timestamp to generate the vessel in port list for. This allows to generate historical snapshots of the vessels that were inside a port at a given time in history. If left blank, then it the vessel list will default to be generated for the current time. format: date-time
mergeSequentialPolygonStays (optional)
Boolean Flag to indicate whether to merge sequential berth stays in same berth (if the stays are within the merge threshold). Default is false, meaning that by default berth stays will not be merged.
mergeThresholdHours (optional)
Double The threshold in hours for a merge to take place for multiple consequtive stays. If the time from when the vessel left the berth until it reentered into the same berth is above the threshold, the polygon stays will not be merged. Default value is 6 hours. format: double
v3GetVesselsInPortResponse - Response object for GetVesselsInPort Up
vesselsInPort (optional)
Long format: int64
data (optional)
array[v3VesselInPort] List of vessels in port at the requested time.
v3GlobalTonnageZoneCount Up
date (optional)
zoneId (optional)
Integer format: int32
zoneName (optional)
vesselCount (optional)
Integer format: int32
vesselDwt (optional)
Double format: double
avgSpeed (optional)
Double format: double
v3HistogramGroup Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
numberOfValues (optional)
Integer Number of observations within the group. format: int32
values (optional)
array[Double] Array of the observed values. format: double
v3HistoricalDryDockStay Up
shipyardStayId (optional)
String Unique ID for the dry dock stay. This will always be unique to the port call.
imo (optional)
Integer IMO number of the vessel. format: int32
mmsi (optional)
Integer MMSI number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
segment (optional)
String Segment of the vessel.
subsegment (optional)
String Sub segment of the vessel.
dwt (optional)
Double format: double
portId (optional)
Integer Oceanbolt database identifier of the port. format: int32
portName (optional)
String Name of the port.
unlocode (optional)
String UNLOCODE of the port.
countryCode (optional)
String Country code of the port.
region (optional)
String Region of the port.
shipyardName (optional)
shipyardId (optional)
Integer Oceanbolt database identifier of the shipyard. format: int32
arrivedAt (optional)
String UTC timestamp for when the vessel arrived at the port.
departedAt (optional)
String UTC timestamp for when the vessel left the port.
durationDays (optional)
Double Duration of the dry dock stay (in days). format: double
v3Layer Up
layerId (optional)
layerName (optional)
ownerUserId (optional)
organization (optional)
polygonsInLayer (optional)
Integer format: int32
polygons (optional)
sharedWithOrg (optional)
v3Layers Up
layers (optional)
predefinedLayers (optional)
v3Leg - Individual leg Up
distance (optional)
Double Distance of the leg in nautical miles. format: double
durationHours (optional)
Double Expected duration of the leg, given a certain speed supplied by the user. format: double
shortestPath (optional)
array[v3Point] The calculated shortest path between the start/end point of the leg.
startingPointModified (optional)
Boolean Flag indicating whether the original starting point was modified. This can happen if the original point supplied was over land.
v3ListCommoditiesResponse Up
commodities (optional)
v3ListCountriesResponse Up
countries (optional)
v3ListPortsResponse Up
ports (optional)
v3ListRegionsResponse Up
regions (optional)
v3ListRegionsWithPolygonResponse Up
regions (optional)
v3ListSegmentsResponse Up
segments (optional)
v3ListStoppageEventsRequest Up
imo (optional)
array[Integer] format: int32
startDate (optional)
endDate (optional)
format (optional)
v3ListStoppageEventsResponse Up
stoppageEvents (optional)
csv (optional)
xlsx (optional)
v3ListTonnageZonesResponse Up
zones (optional)
v3ListTonnageZonesWithPolygonsResponse Up
zones (optional)
v3ListVesselsRequest Up
dwt (optional)
array[Double] format: double
eta (optional)
segment (optional)
subSegment (optional)
loadRegion (optional)
loadCountry (optional)
loadPort (optional)
destinationRegion (optional)
destinationCountry (optional)
destinationPort (optional)
destinationUnlocode (optional)
cargoStatus (optional)
ladenStatus (optional)
ladenStatusDraught (optional)
speed (optional)
array[Double] format: double
draught (optional)
array[Double] format: double
excludeUnknownDestination (optional)
group (optional)
range (optional)
flowDate (optional)
commodity (optional)
commodityGroup (optional)
zoneId (optional)
array[Long] format: int64
portId (optional)
array[Long] format: int64
anchorageId (optional)
array[Long] format: int64
berthId (optional)
array[Long] format: int64
shipyardId (optional)
array[Long] format: int64
direction (optional)
imo (optional)
array[Long] format: int64
portStatus (optional)
excludeMpv (optional)
limit (optional)
Long format: int64
hoursSinceLast (optional)
Long format: int64
format (optional)
v3ListVesselsResponse Up
vessels (optional)
csv (optional)
xlsx (optional)
v3LiveStateRequest Up
dwt (optional)
array[Double] format: double
eta (optional)
segment (optional)
subSegment (optional)
loadRegion (optional)
loadCountry (optional)
loadPort (optional)
destinationRegion (optional)
destinationCountry (optional)
destinationPort (optional)
destinationUnlocode (optional)
cargoStatus (optional)
ladenStatus (optional)
ladenStatusDraught (optional)
speed (optional)
array[Double] format: double
draught (optional)
array[Double] format: double
excludeUnknownDestination (optional)
group (optional)
range (optional)
flowDate (optional)
commodity (optional)
commodityGroup (optional)
boundingBox (optional)
zoneId (optional)
array[Long] format: int64
portId (optional)
array[Long] format: int64
anchorageId (optional)
array[Long] format: int64
berthId (optional)
array[Long] format: int64
shipyardId (optional)
array[Long] format: int64
direction (optional)
imo (optional)
array[Long] format: int64
portStatus (optional)
excludeMpv (optional)
limit (optional)
Long format: int64
hoursSinceLast (optional)
Long format: int64
format (optional)
vesselFilter (optional)
v3LocationVolume Up
locationName (optional)
String Name of the location.
locationId (optional)
String Oceanbolt identifier of the location.
locationType (optional)
String Type of the location.
countryCode (optional)
String ISO 2-letter country code.
value (optional)
Double Aggregated value for the location. format: double
coords (optional)
v3MarineProtectedAreaStay Up
mpaId (optional)
Integer format: int32
mpaName (optional)
countryCode (optional)
imo (optional)
Integer format: int32
vesselName (optional)
enteredAt (optional)
exitedAt (optional)
durationDays (optional)
Double format: double
durationHours (optional)
Double format: double
avgSpeed (optional)
Double format: double
distanceTraveledNm (optional)
Double format: double
v3MpaReportingPeriodRequest Up
imo (optional)
Integer format: int32
startDate (optional)
endDate (optional)
v3MpaSummaryRow Up
imo (optional)
Integer format: int32
vesselName (optional)
startDate (optional)
endDate (optional)
totalDurationDays (optional)
Double format: double
totalDurationHours (optional)
Double format: double
avgSpeed (optional)
Double format: double
totalDistanceTraveledNm (optional)
Double format: double
v3Point - GeoPoint Up
lon (optional)
Double format: double
lat (optional)
Double format: double
v3Polygon Up
berthId (optional)
Long format: int64
portId (optional)
Long format: int64
portName (optional)
berthName (optional)
countryCode (optional)
unlocode (optional)
entityType (optional)
alias (optional)
v3Polygon1 Up
layerId (optional)
polygonId (optional)
polygonName (optional)
metadata (optional)
v3PolygonParams Up
polygonName (optional)
geojson (optional)
metadata (optional)
v3Polygons Up
polygons (optional)
polygonsInLayer (optional)
Integer format: int32
v3Port Up
portId (optional)
Integer format: int32
portName (optional)
countryCode (optional)
region (optional)
unlocode (optional)
unlocodeAlias (optional)
portNameAlias (optional)
v3PortCall - Port call object Up
voyageId (optional)
String Unique ID for the voyage. This can be shared across multiple port calls in the case of parceling voyages.
portCallId (optional)
String Unique ID for the port call. This will always be unique to the port call.
imo (optional)
Integer IMO number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
portId (optional)
Integer Oceanbolt database identifier of the port. format: int32
portName (optional)
String Name of the port.
segment (optional)
String Segment of the vessel.
subSegment (optional)
String Sub segment of the vessel.
unlocode (optional)
String UNLOCODE of the port.
berthId (optional)
Integer Oceanbolt database identifier of the primary berth/terminal visited during the port call. format: int32
berthName (optional)
String Name of the primary berth/terminal visited during the port call.
anchorageId (optional)
Integer Oceanbolt database identifier of the anchorage. format: int32
anchorageName (optional)
String Name of the anchorage.
arrivedAt (optional)
String UTC timestamp for when the vessel arrived at the port.
berthedAt (optional)
String UTC timestamp for when the vessel berthed in the port.
unberthedAt (optional)
String UTC timestamp for when the vessel left the berth/terminal.
departedAt (optional)
String UTC timestamp for when the vessel left the port.
daysInPort (optional)
Double Total duration of the port call (in days). format: double
daysWaiting (optional)
Double Number of days the vessel was waiting at anchor before shifting to berth. format: double
daysAtBerth (optional)
Double Number of days the vessel was at berth in during the duration of the port call. format: double
countryCode (optional)
String ISO 2-letter country code of the load country.
operation (optional)
String Operation type of the port call.
voyageType (optional)
String The type of the voyage.
commodity (optional)
String Name of the commodity.
commodityValue (optional)
String Database friendly name of the commodity.
commodityGroup (optional)
String Name of the commodity group.
volume (optional)
Double Volume loaded in metric tons. format: double
portVisited (optional)
Boolean Flag to indicate whether the vessel has visited the port interior. If the flag is false the vessels only visited an anchorage.
v3PortCallVisits Up
Port calls of one or more vessels in a county.
countryCode (optional)
String ISO 3166 alpha-2 country code.
numberOfPortCalls (optional)
Long Number of port calls made in the country. format: int64
v3Region Up
regionId (optional)
regionName (optional)
v3RegionWithPolygon Up
regionId (optional)
regionName (optional)
geojson (optional)
v3SearchPolygonsResponse Up
polygons (optional)
v3SearchVesselsResponse Up
vessels (optional)
v3Segment Up
segment (optional)
segmentKey (optional)
subSegment (optional)
segmentInt (optional)
Integer format: int32
subSegmentInt (optional)
Integer format: int32
subSegmentKey (optional)
cutoffLow (optional)
Double format: double
cutoffHigh (optional)
Double format: double
platform (optional)
highlevelType (optional)
v3SegmentData Up
subSegment (optional)
count (optional)
Integer format: int32
v3Statistic Up
min (optional)
Double Minimum observed value. format: double
max (optional)
Double Maximum observed value. format: double
percentile10 (optional)
Double 10th percentile of observed values. format: double
percentile50 (optional)
Double 50th percentile of observed values (same as median). format: double
percentile90 (optional)
Double 90th percentile of observed values. format: double
percentile95 (optional)
Double 95th percentile of observed values. format: double
percentile99 (optional)
Double 99th percentile of observed values. format: double
mean (optional)
Double mean of observed values. format: double
v3StoppageEvent Up
imo (optional)
Integer format: int32
startedAt (optional)
endedAt (optional)
portId (optional)
Integer format: int32
portName (optional)
zoneId (optional)
Integer format: int32
zoneName (optional)
minSpeedObserved (optional)
Double format: double
durationHours (optional)
Double format: double
lat (optional)
Double format: double
lon (optional)
Double format: double
classification (optional)
v3TimeIntervalData Up
from (optional)
Integer format: int32
to (optional)
Integer format: int32
count (optional)
Integer format: int32
v3TimeseriesGroup - Generic tonnage timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
v3TimeseriesGroup1 - Port call timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
groupValue (optional)
Double Helper variable to calculate top groups. Not returned. format: double
rows (optional)
array[v3TimeseriesRow1] Rows of timeseries data.
v3TimeseriesGroup2 - Generic tonnage timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3TimeseriesRow2] Rows of timeseries data.
v3TimeseriesGroup3 - Trade flow timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
groupValue (optional)
Double Helper variable to calculate top groups. Not returned. format: double
rows (optional)
array[v3TimeseriesRow3] Rows of timeseries data.
v3TimeseriesRow - Generic tonnage timeseries row Up
date (optional)
value (optional)
Double format: double
v3TimeseriesRow1 - Port call timeseries row Up
date (optional)
String UTC date timestamp of the timeseries row.
value (optional)
Double The value of the timeseries row. format: double
v3TimeseriesRow2 - Generic tonnage timeseries row Up
date (optional)
String UTC date timestamp of the timeseries row.
value (optional)
Double Value of the timeseries row. format: double
v3TimeseriesRow3 - Trade flow timeseries row Up
date (optional)
String UTC date timestamp of the timeseries row.
value (optional)
Double The value of the timeseries row. format: double
v3TonnageChineseWatersRequest - Request object for TonnageChineseWaters Up
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
groupBy (optional)
String Determines the grouping of the timeseries data.
sort (optional)
String Specifies whether results should be sorted in ascending or descing order. Allowed values: ["asc","desc"].
format (optional)
String The return format of the data ["csv","json", "xlsx"]. Default is "json".
v3TonnageChineseWatersResponse - Response object for TonnageChineseWaters Up
timeseries (optional)
array[v3ChineseWatersTimeseriesGroup] Timeseries data groups.
csv (optional)
String Link to download csv file, if format was specified to be "csv".
xlsx (optional)
String Link to download excel file, if format was specified to be "xlsx".
v3TonnageTimeseriesGroup - Tonnage zone/fleet speed timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3TonnageTimeseriesRow] Rows of timeseries data.
v3TonnageTimeseriesRow Up
Tonnage zone/fleet speed timeseries row.
date (optional)
String UTC date timestamp of the timeseries row.
vesselCount (optional)
Integer The number of vessels for the timeseries row. format: int32
vesselDwt (optional)
Double The sum of dwt for the timeseries row. format: double
avgSpeed (optional)
Double The average speed in knots for the timeseries row. format: double
v3TradeFlow - Trade flow object Up
voyageId (optional)
String Unique ID for the voyage. This can be shared across multiple flows in the case of parceling voyages.
flowId (optional)
String Unique ID for the trade flow. This will always be unique to the flow.
imo (optional)
Integer IMO number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
segment (optional)
String Segment of the vessel.
subSegment (optional)
String Sub segment of the vessel.
dwt (optional)
Double DWT of the vessel. format: double
commodity (optional)
String Name of the commodity.
commodityValue (optional)
String Database friendly name of the commodity.
commodityGroup (optional)
String Name of the commodity group.
volume (optional)
Double Volume loaded in metric tons. format: double
loadPortId (optional)
Integer Oceanbolt database identifier of the load port. format: int32
loadPortName (optional)
String Name of the load port.
loadPortUnlocode (optional)
String UNLOCODE of the load port.
loadBerthId (optional)
Integer Oceanbolt database identifier of the load berth/load terminal. format: int32
loadBerthName (optional)
String Name of the load berth/load terminal.
loadCountryCode (optional)
String ISO 2-letter country code of the load country.
loadCountry (optional)
String Name of the load country.
loadRegion (optional)
String Name of the load region.
loadPortArrivedAt (optional)
String UTC timestamp for when the vessel arrived at the load port.
loadPortBerthedAt (optional)
String UTC timestamp for when the vessel berthed in the load port.
loadPortUnberthedAt (optional)
String UTC timestamp for when the vessel left the berth the load port.
loadPortDepartedAt (optional)
String UTC timestamp for when the vessel departed the load port.
loadPortDaysTotal (optional)
Double Total duration of the load port call (in days). format: double
loadPortDaysBerthed (optional)
Double Number of days the vessel was at berth in the load port. format: double
loadPortDaysWaiting (optional)
Double Number of days the vessel was waiting at the load port before shifting to berth. format: double
dischargePortId (optional)
Integer Oceanbolt database identifier of the load berth/load terminal. format: int32
dischargePortName (optional)
String Name of the load port.
dischargePortUnlocode (optional)
String UNLOCODE of the load port.
dischargeBerthId (optional)
Integer Oceanbolt database identifier of the load berth/load terminal. format: int32
dischargeBerthName (optional)
String Name of the load berth/load terminal.
dischargeCountryCode (optional)
String ISO 2-letter country code of the load country.
dischargeCountry (optional)
String Name of the load country.
dischargeRegion (optional)
String Name of the load region.
dischargePortArrivedAt (optional)
String UTC timestamp for when the vessel arrived at the discharge port.
dischargePortBerthedAt (optional)
String UTC timestamp for when the vessel berthed in the discharge port.
dischargePortUnberthedAt (optional)
String UTC timestamp for when the vessel left the berth the discharge port.
dischargePortDepartedAt (optional)
String UTC timestamp for when the vessel departed the discharge port.
dischargePortDaysTotal (optional)
Double Total duration of the load port call (in days). format: double
dischargePortDaysBerthed (optional)
Double Number of days the vessel was at berth in the discharge port. format: double
dischargePortDaysWaiting (optional)
Double Number of days the vessel was waiting at the discharge port before shifting to berth. format: double
daysSteaming (optional)
Double Number of days the vessel was steaming (the time from when it left the discharge port until it arrived at the discharge port). format: double
daysTotalDuration (optional)
Double Total duration of the voyage (in days). format: double
distanceCalculated (optional)
Double Calculated distance in nautical miles between load port and discharge port. Based on port distance tables. format: double
distanceActual (optional)
Double Actual distance sailed in nautical miles between load port and discharge port. Based on AIS tracks. format: double
eta (optional)
String Captain's Reported ETA.
destination (optional)
String Captain's Reported Destination.
status (optional)
String Status of the trade flow.
parceling (optional)
Boolean Flag indicating whether the trade flow was part of a parceling voyage or a single voyage.
ballastStartedAt (optional)
String UTC timestamp for when the vessel started ballasting from the last discharge port.
ballastPortName (optional)
String Name of the port where the vessel ballasted from.
ballastPortId (optional)
Integer Oceanbolt database identifier for the port where the vessel ballasted from. format: int32
ballastPortUnlocode (optional)
ballastCountry (optional)
String Name of the ballast country.
ballastCountryCode (optional)
String ISO 2-letter country code of the ballast country.
ballastRegion (optional)
String Name of the ballast region.
v3TradeFlowDataRequest - Trade flow data requests object. This is shared between all trade flows queries Up
frequency (optional)
String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>["daily", "weekly", "monthly","quarterly", "yearly"]</strong>. Default value is "monthly". This parameter only applies to the <strong>/tradeflows/timeseries</strong> endpoint.
commodity (optional)
array[String] List of commodities to get data for (get a list of all commodities from <strong>/entities/commodities</strong>).
commodityGroup (optional)
array[String] List of commodity groups to get data for (get a list of all commodity groups from <strong>/entities/commodities</strong>).
flowDirection (optional)
String This controls whether to group the date by export date/import date. Allowed values are **["export","import"]. Default value is "export". This parameter only applies to the <strong>/tradeflows/timeseries</strong> endpoint.
imo (optional)
array[Integer] List of unique vessel identifiers (IMO numbers). This allows filtering to show data only for a subset of vessels. Example: [1234567,7654321]. format: int32
loadPortId (optional)
array[Integer] Oceanbolt database identifier of the load port. format: int32
loadPortUnlocode (optional)
array[String] List of five letter UNLOCODEs for load (export) ports to filter on.
loadBerthId (optional)
array[Integer] Oceanbolt database identifier of the load berth/terminal. format: int32
dischargePortId (optional)
array[Integer] Oceanbolt database identifier of the discharge port. format: int32
dischargePortUnlocode (optional)
array[String] List of five letter UNLOCODEs for discharge (import) ports to filter on.
dischargeBerthId (optional)
array[Integer] Oceanbolt database identifier of the discharge berth/terminal. format: int32
segment (optional)
array[String] List of vessel segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside subSegment.
subSegment (optional)
array[String] List of vessel sub segments to filter on. Allowed values can be obtained from the <strong>/entities/segments</strong> endpoint. Cannot be supplied alongside segment.
startDate (optional)
String The UTC start date of the date filter.
endDate (optional)
String The UTC end date of the date filter.
loadCountryCode (optional)
array[String] List of two letter ISO country codes for loading (export) countries to filter on.
dischargeCountryCode (optional)
array[String] List of two letter ISO country codes for discharge (import) countries to filter on.
loadRegion (optional)
array[String] List of loading regions to filter on. Allowed values can be obtained from the <strong>/entities/regions</strong> endpoint.
dischargeRegion (optional)
array[String] List of discharge regions to filter on. Allowed values can be obtained from the <strong>/entities/regions</strong> endpoint.
status (optional)
excludeIntraCountry (optional)
Boolean Determines whether to include/exclude intra country voyages. Default is to include.
excludeUnknownDestinations (optional)
Boolean Determines whether to include/exclude voyages with unknown destination. Default is to include.
excludeMissingLoadBerth (optional)
Boolean Determines whether to include/exclude voyages with that have a missing load_berth_id. Default is to include.
excludeMissingDischargeBerth (optional)
Boolean Determines whether to include/exclude voyages with that have a missing discharge_berth_id. Default is to include.
nextToken (optional)
String The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
maxResults (optional)
Integer An optional limit for the number of resources returned in a single call. format: int32
format (optional)
String The return format of the data ["csv", "json", "xlsx"]. Default is "json".
groupBy (optional)
String Determines the grouping of the timeseries data. This parameter only applies to the <strong>/tradeflows/timeseries</strong> endpoint.
pivotBy (optional)
String Not implemented.
tallFormat (optional)
Boolean Not implemented.
metric (optional)
String The metric to retrieve for timeseries aggregations. Allowed values: ["volume","count","ton_mile_calculated","ton_mile_actual","average_haul","average_speed", "volume_times_duration"]. Default is "volume".
parceling (optional)
array[String] List of parceling statuses to retrieve. Allowed values are: ["include","exclude","only"].
limitGroups (optional)
Boolean Flag to indicate whether grouped timeseries should be limited to top N entries. If the parameter is present, the endpoint will only return the top N groups, and the remaining entries will be grouped into others.
lastNDays (optional)
Integer Short hand parameter for quickly getting data for the last N days. Cannot be supplied along either start_date or end_date. format: int32
sort (optional)
String Specifies whether results should be sorted in ascending or descending order. Allowed values: ["asc","desc"].
dwt (optional)
array[Double] DWT range to filter on. Example: [60000,90000] - this would filter only to only include dwt between 60k and 90k (both values inclusive). format: double
category (optional)
String Specifies the base category for aggregation queries. This parameter only has effect on the GetTradeFlowAggregation method (REST endpoint: /tradeflows/aggregation).
vesselFilter (optional)
v3TradeLaneMetric Up
group (optional)
avgDaysAtSea (optional)
Double format: double
avgLoadPortDaysWaiting (optional)
Double format: double
avgLoadPortDaysBerthed (optional)
Double format: double
avgDischargePortDaysWaiting (optional)
Double format: double
avgDischargePortDaysBerthed (optional)
Double format: double
avgVoyageDurationsDays (optional)
Double format: double
avgSpeed (optional)
Double format: double
avgVolume (optional)
Double format: double
avgDistanceNm (optional)
Double format: double
avgDistanceCalculatedNm (optional)
Double format: double
medianDaysAtSea (optional)
Double format: double
medianLoadPortDaysWaiting (optional)
Double format: double
medianLoadPortDaysBerthed (optional)
Double format: double
medianDischargePortDaysWaiting (optional)
Double format: double
medianDischargePortDaysBerthed (optional)
Double format: double
medianVolume (optional)
Double format: double
medianDistanceNm (optional)
Double format: double
numberOfVoyages (optional)
Integer format: int32
sumOfVolume (optional)
Double format: double
uniqueVessels (optional)
Integer format: int32
uniqueLoadPorts (optional)
Integer format: int32
uniqueDischargePorts (optional)
Integer format: int32
v3UpdateVesselParams - Parameter object for updating a vessel in a Fleet Up
metadata (optional)
map[String, String] New set of metadata information for a Vessel. This will overwrite existing keys/values currently stored in the metadata object of the Vessel.
v3Vessel Up
imo (optional)
Long format: int64
highlevelType (optional)
segment (optional)
subSegment (optional)
dwt (optional)
Double format: double
maxDraught (optional)
Double format: double
name (optional)
exName (optional)
built (optional)
Long format: int64
type (optional)
mpv (optional)
loa (optional)
Double format: double
beam (optional)
Double format: double
holdsTotal (optional)
Double format: double
v3Vessel1 - Vessel object Up
imo (optional)
Integer IMO number of the vessel. format: int32
dwt (optional)
Double DWT of the vessel. format: double
built (optional)
Integer The year the vessel was built. format: int32
vesselName (optional)
String Current name of the Vessel.
segment (optional)
String Name of the segment which the vessel belongs to.
subSegment (optional)
String Flag code of the country where the vessel is currently registered.
flagCode (optional)
String Flag code of the country where the vessel is currently registered.
exName (optional)
String Ex name of the Vessel.
type (optional)
String The type of the vessel.
metadata (optional)
map[String, String] Metadata object that contains arbitrary data fields defined by the user.
status (optional)
stoppageEvents (optional)
array[v3VesselStoppageEvent] Vessel speed events (stopage data).
v3Vessel2 Up
vesselName (optional)
imo (optional)
Long format: int64
mmsi (optional)
Long format: int64
lastPositionReceived (optional)
lastStaticReceived (optional)
dwt (optional)
Double format: double
segment (optional)
subSegment (optional)
zoneId (optional)
Long format: int64
zoneName (optional)
portId (optional)
Long format: int64
portName (optional)
anchorageId (optional)
Long format: int64
anchorageName (optional)
berthId (optional)
Long format: int64
berthName (optional)
shipyardId (optional)
Long format: int64
shipyardName (optional)
relatedPortId (optional)
Long format: int64
relatedPortName (optional)
cargoStatus (optional)
ladenStatus (optional)
ladenStatusDraught (optional)
destination (optional)
destinationPortName (optional)
destinationRegion (optional)
destinationCountryCode (optional)
eta (optional)
navigationalStatus (optional)
Long format: int64
lastPortName (optional)
lastCountryCode (optional)
lastRegion (optional)
portCallStatus (optional)
commodityGroup (optional)
commodityName (optional)
direction (optional)
speed (optional)
Double format: double
v3Vessel3 Up
vesselName (optional)
imo (optional)
Long format: int64
mmsi (optional)
Long format: int64
lastPositionReceived (optional)
lastStaticReceived (optional)
dwt (optional)
Double format: double
segment (optional)
subSegment (optional)
zoneId (optional)
Long format: int64
zoneName (optional)
portId (optional)
Long format: int64
portName (optional)
anchorageId (optional)
Long format: int64
anchorageName (optional)
berthId (optional)
Long format: int64
berthName (optional)
shipyardId (optional)
Long format: int64
shipyardName (optional)
relatedPortId (optional)
Long format: int64
relatedPortName (optional)
cargoStatus (optional)
ladenStatus (optional)
ladenStatusDraught (optional)
destination (optional)
destinationPortName (optional)
destinationRegion (optional)
destinationCountryCode (optional)
eta (optional)
navigationalStatus (optional)
Long format: int64
lastPortName (optional)
lastCountryCode (optional)
lastRegion (optional)
portCallStatus (optional)
commodityGroup (optional)
commodityName (optional)
direction (optional)
speed (optional)
Double format: double
v3VesselGeoObject Up
imo (optional)
Long format: int64
mmsi (optional)
Long format: int64
vesselName (optional)
course (optional)
Double format: double
speed (optional)
Double format: double
ladenStatus (optional)
geomCoordinates (optional)
v3VesselInPort - VesselInPort object Up
voyageId (optional)
String Unique ID for the voyage. This can be shared across multiple port calls in the case of parceling voyages.
portCallId (optional)
String Unique ID for the port call. This will always be unique to the port call.
imo (optional)
Integer IMO number of the vessel. format: int32
vesselName (optional)
String Name of the vessel.
portId (optional)
Integer Oceanbolt database identifier of the port. format: int32
portName (optional)
String Name of the port.
unlocode (optional)
String UNLOCODE of the port.
segment (optional)
String Segment of the vessel.
subSegment (optional)
String Sub segment of the vessel.
dwt (optional)
Double format: double
berthId (optional)
Integer Oceanbolt database identifier of the primary berth/terminal visited during the port call. format: int32
berthName (optional)
String Name of the primary berth/terminal visited during the port call.
anchorageId (optional)
Integer Oceanbolt database identifier of the anchorage. format: int32
anchorageName (optional)
String Name of the anchorage.
arrivedAt (optional)
String UTC timestamp for when the vessel arrived at the port.
departedAt (optional)
String UTC timestamp for when the vessel left the port (only applies for historical snapshot views), if blank, then the vessel is still inside the port.
daysInPort (optional)
Double Total duration of the port call (in days). format: double
countryCode (optional)
String ISO 2-letter country code of the load country.
operation (optional)
String Predicted operation type of the port call.
voyageType (optional)
String Predicted the type of the voyage.
commodity (optional)
String Name of the predicted commodity.
commodityValue (optional)
String Database friendly name of the predicted commodity.
commodityGroup (optional)
String Name of the predicted commodity group.
volume (optional)
Double Volume loaded in metric tons. format: double
portVisited (optional)
Boolean Flag to indicate whether the vessel has visited the port interior. If the flag is false the vessels only visited an anchorage or a berth.
berthStays (optional)
anchorageStays (optional)
vesselStatus (optional)
v3VesselParams - Vessel parameters Up
imo (optional)
Integer Imo of the vessel. format: int32
metadata (optional)
map[String, String] A dict/map of arbitratry metadata that should be added to the vessel in the context of the current fleet. This can for example be links to internal voyage systems (Vezon/Imoset etc.) it can be current voyage related data or similar. The metadata is only accessible by the current user. If the current user chooses to share the fleet, it will also be accesible by users who belong to the same organization as the fleet owner.
v3VesselSegmentByTime Up
subSegment (optional)
data (optional)
v3VesselState - VesselState object Up
vesselName (optional)
String Name of the vessel.
imo (optional)
Long IMO number of the vessel. format: int64
mmsi (optional)
Long MMSI number of the vessel. format: int64
timestamp (optional)
String UTC timestamp for the VesselState.
dwt (optional)
Double DWT of the vessel. format: double
segment (optional)
String Segment of the vessel.
subSegment (optional)
String Sub segment of the vessel.
vesselType (optional)
String The vessel type.
zoneId (optional)
Long format: int64
zoneName (optional)
portId (optional)
Long format: int64
portName (optional)
anchorageId (optional)
Long format: int64
anchorageName (optional)
berthId (optional)
Long format: int64
berthName (optional)
shipyardId (optional)
Long format: int64
shipyardName (optional)
relatedPortId (optional)
Long format: int64
relatedPortName (optional)
vesselStatus (optional)
ladenStatusModel (optional)
String The laden status of the vessel as determined from the the Oceanbolt Algorithms, taking into account prior berth visits, prior draught changes etc.
ladenStatusDraught (optional)
String The laden status according to the current draught as reported by the Master.
destination (optional)
destinationPortId (optional)
Long format: int64
destinationPortName (optional)
destinationRegion (optional)
destinationCountryCode (optional)
destinationScore (optional)
Double format: double
predictedDestinationPortId (optional)
Long format: int64
predictedDestinationPortName (optional)
predictedDestinationRegion (optional)
predictedDestinationCountryCode (optional)
predictedDestinationScore (optional)
Double format: double
eta (optional)
navigationalStatus (optional)
navigationalStatusCode (optional)
Long format: int64
portCallStatus (optional)
commodityId (optional)
Long format: int64
commodityGroup (optional)
commodityName (optional)
direction (optional)
speedStatus (optional)
lastVisitedPortId (optional)
Long format: int64
lastVisitedPortName (optional)
lastOpsPortId (optional)
Long format: int64
lastOpsPortName (optional)
volumeOnBoard (optional)
Double format: double
hoursCarriedForward (optional)
Long A indicator describing if the given VesselState was recorded directly from AIS, or if it was backfilled and carried forward from the last received observation. The value is zero for observations that are derived directly from a received AIS position, for observations that are carried forward the value will indicate the number of hours the current observations has been carried forward. format: int64
v3VesselStatesResponse Up
Request message for VesselStateService.GetVesselStates and VesselStateService.GetVesselStatesForDate.
vesselStates (optional)
array[v3VesselState] A collection of VesselState objects that is returned by the API.
v3VesselStatus Up
ladenStatus (optional)
cargoStatus (optional)
portCallStatus (optional)
relatedPortName (optional)
draughtPercentage (optional)
Double format: double
destination (optional)
destinationPortName (optional)
lastPositionReceivedAt (optional)
lastStaticReceivedAt (optional)
currentSpeed (optional)
Double format: double
currentNavigationalStatus (optional)
Integer format: int32
currentCommodityGroup (optional)
v3VesselStoppageEvent Up
startedAt (optional)
endedAt (optional)
portId (optional)
Integer format: int32
portName (optional)
zoneId (optional)
Integer format: int32
zoneName (optional)
minSpeedObserved (optional)
Double format: double
durationHours (optional)
Double format: double
lat (optional)
Double format: double
lon (optional)
Double format: double
classification (optional)
v3Vessels - List of Vessel objects Up
vessels (optional)
array[v3Vessel1] List of vessels in Fleet.
vesselsInFleet (optional)
Integer Number of vessels in a Fleet. format: int32
v3VesselsInAreaResponse Up
vesselsTotal (optional)
Integer format: int32
vesselsReturned (optional)
Integer format: int32
vesselsInView (optional)
Integer format: int32
vessels (optional)
v3VesselsResponse Up
vessels (optional)
csv (optional)
xlsx (optional)
v3Zone Up
zoneId (optional)
Integer format: int32
zoneName (optional)
v3ZoneBySegment Up
zoneName (optional)
data (optional)
v3ZoneByTime Up
zoneName (optional)
data (optional)
v3ZoneChangesTimeseriesGroup - Tonnage zone/fleet speed timeseries group Up
group (optional)
String Name of the group. This will be "default", if no grouping was specified in the query.
rows (optional)
array[v3ZoneChangesTimeseriesRow] Rows of timeseries data.
v3ZoneChangesTimeseriesRow Up
Tonnage zone/fleet speed timeseries row.
date (optional)
String UTC date timestamp of the timeseries row.
vesselCount (optional)
Integer The number of vessels for the timeseries row. format: int32
vesselDwt (optional)
Double The sum of dwt for the timeseries row. format: double
v3ZoneWithPolygon Up
zoneId (optional)
Integer format: int32
zoneName (optional)
zoneBasin (optional)
geomPolygonWkt (optional)
geomPolygonGeojson (optional)
geomCoordinateWkt (optional)
geomCoordinateGeojson (optional)