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",<