Skip to main content
Skip table of contents

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:

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

Methods

Table of Contents

Models

Table of Contents

  1. DistanceResponseDistanceAlgorithmStatus

  2. GetAisSummaryRequestResolution

  3. Request object for adding a Vessel to a Fleet - Request object for adding a Vessel to a Fleet

  4. Request object for batch adding Vessels to a Fleet - Request object for batch adding Vessels to a Fleet

  5. Request object for batch adding Veming a Fleet - Request object for renaming a Fleet

  6. Request object for updating a vessel - Request object for updating a vessel

  7. distancecalculatorv3Location

  8. filtersVesselFilter

  9. layerId_batchaddpolygons_body

  10. layerId_renamelayer_body

  11. layerId_replacepolygons_body

  12. protobufAny

  13. rpcStatus

  14. v3AggregationGroup

  15. v3AggregationRow

  16. v3AisQualityResponse

  17. v3AnchorageStay - AnchorageStay object

  18. v3BatchDistanceRequest - Request object for BatchCalculateDistance method

  19. v3BatchDistanceResponse - Response object for BatchCalculateDistance method

  20. v3BerthStay - BerthStay object

  21. v3BoundingBox

  22. v3ChineseWatersTimeseriesGroup

  23. v3ChineseWatersTimeseriesRow

  24. v3Commodity

  25. v3CongestionResponse

  26. v3CongestionSplitRow

  27. v3CongestionStay

  28. v3CongestionTimeseriesGroup

  29. v3CongestionTimeseriesRow

  30. v3Country

  31. v3CreateFleetRequest - Request object for creating a Fleet

  32. v3CreateLayerRequest

  33. v3CustomPolygonRequest - Request object for GetPolygonCounts

  34. v3CustomPolygonResponse - Response object for GetPolygonCounts

  35. v3DistanceRequest - Request object for CalculateDistance method

  36. v3DistanceResponse

  37. v3DryDockResponse

  38. v3DryDockSplitRow

  39. v3DryDockStay

  40. v3DryDockTimeseriesGroup

  41. v3DryDockTimeseriesRow

  42. v3EmptyResponse - Empty response object

  43. v3EmptyResponse1

  44. v3Fleet - Fleet resource

  45. v3FleetGrowthTimeseriesGroup - Fleet growth timeseries group

  46. v3FleetGrowthTimeseriesRow - Fleet growth timeseries row

  47. v3Fleets - Response object for listing Fleets

  48. v3GeoPoint

  49. v3GetAisSummaryRequest - Request object for GetAisSummaryRequest

  50. v3GetAisSummaryResponse - Request object for GetAisSummaryResponse

  51. v3GetCongestionRequest

  52. v3GetCorruptPortCallsRequest

  53. v3GetCorruptPortCallsResponse

  54. v3GetDryDockRequest

  55. v3GetDryDockStaysRequest - DryDockstays

  56. v3GetDryDockStaysResponse

  57. v3GetFleetListRequest - Request object for parsing a file into a fleet

  58. v3GetFleetLiveMapResponse - GetFleetLiveMapRequest request object for getting static fleet map

  59. v3GetFleetSpeedResponse - Response object for FleetSpeed

  60. v3GetGlobalTonnageStatusResponse

  61. v3GetLocationVolumeResponse

  62. v3GetMarineProtectedAreaStaysResponse

  63. v3GetMarineProtectedAreaSummaryRequest

  64. v3GetMarineProtectedAreaSummaryResponse

  65. v3GetPortCallTimeseriesResponse - Response object for port call timeseries queries

  66. v3GetPortCallsRequest - Port calls data requests object. This is shared between all port calls queries

  67. v3GetPortCallsResponse - Response object for port call queries

  68. v3GetPortParticularsRequest - Request object for GetPortParticulars

  69. v3GetPortParticularsResponse - Response object for GetPortParticulars

  70. v3GetTonnageBasinRequest - GetTonnageBasin

  71. v3GetTonnageBasinResponse

  72. v3GetTonnageDataRequest

  73. v3GetTonnageFleetGrowthResponse - Response object for GetTonnageFleetGrowth

  74. v3GetTonnageFleetRequest - Request object for GetTonnageFleetStatus and GetTonnageFleetGrowth

  75. v3GetTonnageFleetStatusResponse - Response object for GetTonnageFleetStatus

  76. v3GetTonnageZoneChangesRequest - Request object for TonnageZoneChange

  77. v3GetTonnageZoneChangesResponse - Response object for TonnageZoneChange

  78. v3GetTonnageZoneCountResponse - Response object for tonnage zone counts

  79. v3GetTradeFlowAggregationResponse

  80. v3GetTradeFlowHistogramResponse

  81. v3GetTradeFlowTimeseriesResponse - Response object for trade flow timeseries queries

  82. v3GetTradeFlowsResponse - Response object for trade flow queries

  83. v3GetTradeLaneMetricsResponse

  84. v3GetVesselStatesForDateRequest - Request message for VesselStateService.GetVesselStatesForDate

  85. v3GetVesselStatesRequest - Request message for VesselStateService.GetVesselStates

  86. v3GetVesselsInPortRequest - Request object for GetVesselsInPort

  87. v3GetVesselsInPortResponse - Response object for GetVesselsInPort

  88. v3GlobalTonnageZoneCount

  89. v3HistogramGroup

  90. v3HistoricalDryDockStay

  91. v3Layer

  92. v3Layers

  93. v3Leg - Individual leg

  94. v3ListCommoditiesResponse

  95. v3ListCountriesResponse

  96. v3ListPortsResponse

  97. v3ListRegionsResponse

  98. v3ListRegionsWithPolygonResponse

  99. v3ListSegmentsResponse

  100. v3ListStoppageEventsRequest

  101. v3ListStoppageEventsResponse

  102. v3ListTonnageZonesResponse

  103. v3ListTonnageZonesWithPolygonsResponse

  104. v3ListVesselsRequest

  105. v3ListVesselsResponse

  106. v3LiveStateRequest

  107. v3LocationVolume

  108. v3MarineProtectedAreaStay

  109. v3MpaReportingPeriodRequest

  110. v3MpaSummaryRow

  111. v3Point - GeoPoint

  112. v3Polygon

  113. v3Polygon1

  114. v3PolygonParams

  115. v3Polygons

  116. v3Port

  117. v3PortCall - Port call object

  118. v3PortCallVisits

  119. v3Region

  120. v3RegionWithPolygon

  121. v3SearchPolygonsResponse

  122. v3SearchVesselsResponse

  123. v3Segment

  124. v3SegmentData

  125. v3Statistic

  126. v3StoppageEvent

  127. v3TimeIntervalData

  128. v3TimeseriesGroup - Generic tonnage timeseries group

  129. v3TimeseriesGroup1 - Port call timeseries group

  130. v3TimeseriesGroup2 - Generic tonnage timeseries group

  131. v3TimeseriesGroup3 - Trade flow timeseries group

  132. v3TimeseriesRow - Generic tonnage timeseries row

  133. v3TimeseriesRow1 - Port call timeseries row

  134. v3TimeseriesRow2 - Generic tonnage timeseries row

  135. v3TimeseriesRow3 - Trade flow timeseries row

  136. v3TonnageChineseWatersRequest - Request object for TonnageChineseWaters

  137. v3TonnageChineseWatersResponse - Response object for TonnageChineseWaters

  138. v3TonnageTimeseriesGroup - Tonnage zone/fleet speed timeseries group

  139. v3TonnageTimeseriesRow

  140. v3TradeFlow - Trade flow object

  141. v3TradeFlowDataRequest - Trade flow data requests object. This is shared between all trade flows queries

  142. v3TradeLaneMetric

  143. v3UpdateVesselParams - Parameter object for updating a vessel in a Fleet

  144. v3Vessel

  145. v3Vessel1 - Vessel object

  146. v3Vessel2

  147. v3Vessel3

  148. v3VesselGeoObject

  149. v3VesselInPort - VesselInPort object

  150. v3VesselParams - Vessel parameters

  151. v3VesselSegmentByTime

  152. v3VesselState - VesselState object

  153. v3VesselStatesResponse

  154. v3VesselStatus

  155. v3VesselStoppageEvent

  156. v3Vessels - List of Vessel objects

  157. v3VesselsInAreaResponse

  158. v3VesselsResponse

  159. v3Zone

  160. v3ZoneBySegment

  161. v3ZoneByTime

  162. v3ZoneChangesTimeseriesGroup - Tonnage zone/fleet speed timeseries group

  163. v3ZoneChangesTimeseriesRow

  164. v3ZoneWithPolygon

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)

v3VesselParams

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)

v3UpdateVesselParams

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)

v3Point

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)

array[v3PolygonParams]

upsert (optional)

Boolean

layerId_renamelayer_body Up

newLayerName (optional)

String

layerId_replacepolygons_body Up

polygons (optional)

array[v3PolygonParams]

upsert (optional)

Boolean

protobufAny Up

rpcStatus Up

code (optional)

Integer format: int32

message (optional)

String

details (optional)

array[protobufAny]

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)

array[v3VesselSegmentByTime]

zonesByTime (optional)

array[v3ZoneByTime]

zonesBySegment (optional)

array[v3ZoneBySegment]

v3AnchorageStay - AnchorageStay object Up

anchorageId (optional)

Long format: int64

anchorageName (optional)

String

arrivedAt (optional)

String

departedAt (optional)

String

hoursInAnchorage (optional)

Double The duration of the stay in the anchorage in hours. format: double

v3BatchDistanceRequest - Request object for BatchCalculateDistance method Up

requests (optional)

array[v3DistanceRequest]

v3BatchDistanceResponse - Response object for BatchCalculateDistance method Up

responses (optional)

array[v3DistanceResponse]

v3BerthStay - BerthStay object Up

berthId (optional)

Long format: int64

berthName (optional)

String

berthType (optional)

String

arrivedAt (optional)

String

departedAt (optional)

String

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 &quot;default&quot;, 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)

String

commodityId (optional)

Integer format: int32

commodityValue (optional)

String

commodityGroup (optional)

String

platform (optional)

String

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)

v3CongestionTimeseriesGroup

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3CongestionSplitRow Up

item (optional)

String

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 &quot;default&quot;, 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)

String

countryCode (optional)

String

v3CreateFleetRequest - Request object for creating a Fleet Up

fleetName (optional)

String The new name of the Fleet.

v3CreateLayerRequest Up

layerName (optional)

String

v3CustomPolygonRequest - Request object for GetPolygonCounts Up

geojson (optional)

String

ladenStatus (optional)

array[String]

segment (optional)

array[String]

subSegment (optional)

array[String]

startDate (optional)

String

endDate (optional)

String

v3CustomPolygonResponse - Response object for GetPolygonCounts Up

timeseries (optional)

array[v3TimeseriesGroup]

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)

Boolean

blockPanama (optional)

Boolean

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)

array[v3Leg]

status (optional)

DistanceResponseDistanceAlgorithmStatus

v3DryDockResponse Up

DryDock responseobject.

numberOfCurrentVessels (optional)

Integer format: int32

currentTopPorts (optional)

array[v3DryDockSplitRow]

currentTopSubSegments (optional)

array[v3DryDockSplitRow]

currentTopCountries (optional)

array[v3DryDockSplitRow]

currentTopShipyards (optional)

array[v3DryDockSplitRow]

timeseriesDefault (optional)

v3DryDockTimeseriesGroup

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3DryDockSplitRow Up

item (optional)

String

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)

String

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 &quot;default&quot;, if no grouping was specified in the query.

rows (optional)

array[v3DryDockTimeseriesRow]

v3DryDockTimeseriesRow Up

DryDock timeseries row object.

date (optional)

String

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)

String

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 &quot;default&quot;, 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: **[&quot;load&quot;,&quot;discharge&quot;;&quot;yard&quot;,&quot;unknown&quot;].

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 [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

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: [&quot;asc&quot;,&quot;desc&quot;].

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)

filtersVesselFilter

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)

array[String]

subSegment (optional)

array[String]

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 [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

startDate (optional)

String

endDate (optional)

String

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: [&quot;asc&quot;,&quot;desc&quot;].

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)

String

endDate (optional)

String

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 [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

sort (optional)

String Specifies whether results should be sorted in ascending or descing order. Allowed values: [&quot;asc&quot;,&quot;desc&quot;].

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)

String

xlsx (optional)

String

previousToken (optional)

String

nextToken (optional)

String

maxResults (optional)

Integer format: int32

v3GetFleetListRequest - Request object for parsing a file into a fleet Up

fileName (optional)

String

file (optional)

byte[] format: byte

fleetId (optional)

String

fleetName (optional)

String

overwrite (optional)

Boolean

v3GetFleetLiveMapResponse - GetFleetLiveMapRequest request object for getting static fleet map Up

mapImage (optional)

String

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3GetGlobalTonnageStatusResponse Up

globalTonnageZoneCounts (optional)

array[v3GlobalTonnageZoneCount]

csv (optional)

String

xlsx (optional)

String

v3GetLocationVolumeResponse Up

data (optional)

array[v3LocationVolume] List of locations.

v3GetMarineProtectedAreaStaysResponse Up

mpaStays (optional)

array[v3MarineProtectedAreaStay]

file (optional)

String

v3GetMarineProtectedAreaSummaryRequest Up

reportingPeriods (optional)

array[v3MpaReportingPeriodRequest]

format (optional)

String

v3GetMarineProtectedAreaSummaryResponse Up

summaryRows (optional)

array[v3MpaSummaryRow]

mpaStays (optional)

array[v3MarineProtectedAreaStay]

file (optional)

String

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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: [&quot;atlantic&quot;,&quot;indian_ocean&quot;,&quot;pacific_americas&quot;,&quot;pacific_asia&quot;].

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 [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

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: **[&quot;D&quot;,&quot;Dx&quot;;&quot;L&quot;,&quot;Lx&quot;,&quot;B&quot;,&quot;Y&quot;,&quot;U&quot;].

sort (optional)

String Specifies whether results should be sorted in ascending or descing order. Allowed values: [&quot;asc&quot;,&quot;desc&quot;].

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>[&quot;daily&quot;, &quot;weekly&quot;, &quot;monthly&quot;,&quot;quarterly &quot;yearly&quot;]</strong>. Default value is &quot;monthly&quot;. 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)

filtersVesselFilter

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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)

v3Statistic

beam (optional)

v3Statistic

maxDraught (optional)

v3Statistic

reportedDraught (optional)

v3Statistic

dwt (optional)

v3Statistic

airDraught (optional)

v3Statistic

v3GetTonnageBasinRequest - GetTonnageBasin Up

basin (optional)

array[String]

segment (optional)

array[String]

subSegment (optional)

array[String]

startDate (optional)

String

endDate (optional)

String

excludeMpv (optional)

Boolean

lastNDays (optional)

Integer format: int32

format (optional)

String

v3GetTonnageBasinResponse Up

timeseries (optional)

array[v3TonnageTimeseriesGroup]

csv (optional)

String

xlsx (optional)

String

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>[&quot;NNE&quot;,&quot;ENE&quot;,&quot;ESE&quot;,&quot;SSE&quot;,&quot;SSW&quot;,&quot;WSW&quot;,&quot;WNW&quot;,&quot;NNW&quot;]</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>[&quot;laden&quot;,&quot;ballast&quot;]</strong>.

portStatus (optional)

array[String] The port status to get tonnage data for. The following values are allowed: <strong>[&quot;in_port&quot;,&quot;at_sea&quot;]</strong>.

groupBy (optional)

String

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 [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

sort (optional)

String Specifies whether results should be sorted in ascending or descing order. Allowed values: [&quot;asc&quot;,&quot;desc&quot;].

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3GetTonnageFleetRequest - Request object for GetTonnageFleetStatus and GetTonnageFleetGrowth Up

frequency (optional)

String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>[&quot;daily&quot;, &quot;weekly&quot;, &quot;monthly&quot;,&quot;quarterly &quot;yearly&quot;]</strong>. Default value is &quot;monthly&quot;.

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: [&quot;count&quot;,&quot;dwt&quot;]. Default is &quot;count&quot;.

format (optional)

String The return format of the data [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

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: [&quot;asc&quot;,&quot;desc&quot;].

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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>[&quot;laden&quot;,&quot;ballast&quot;]</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: [&quot;asc&quot;,&quot;desc&quot;].

format (optional)

String The return format of the data [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

frequency (optional)

String Frequency determines the granularity/period grouping of the timeseries. Allowed values are: <strong>[&quot;daily&quot;, &quot;weekly&quot;, &quot;monthly&quot;,&quot;quarterly &quot;yearly&quot;]</strong>. Default value is &quot;monthly&quot;.

vesselFilter (optional)

filtersVesselFilter

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3GetTradeFlowAggregationResponse Up

data (optional)

array[v3AggregationGroup] List of aggregation rows.

csv (optional)

String Link to download csv file, if format was specified to be &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3GetTradeLaneMetricsResponse Up

groupingVariable (optional)

String

numberOfGroups (optional)

Integer format: int32

tradeLaneMetrics (optional)

array[v3TradeLaneMetric]

v3GetVesselStatesForDateRequest - Request message for VesselStateService.GetVesselStatesForDate Up

date (optional)

String

v3GetVesselStatesRequest - Request message for VesselStateService.GetVesselStates Up

imo (optional)

array[Integer] format: int32

startDate (optional)

String

endDate (optional)

String

v3GetVesselsInPortRequest - Request object for GetVesselsInPort Up

portId (optional)

Long format: int64

unlocode (optional)

String

vesselFilter (optional)

filtersVesselFilter

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)

String

zoneId (optional)

Integer format: int32

zoneName (optional)

String

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 &quot;default&quot;, 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)

String

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)

String

layerName (optional)

String

ownerUserId (optional)

String

organization (optional)

String

polygonsInLayer (optional)

Integer format: int32

polygons (optional)

array[v3Polygon1]

sharedWithOrg (optional)

Boolean

v3Layers Up

layers (optional)

array[v3Layer]

predefinedLayers (optional)

array[v3Layer]

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)

array[v3Commodity]

v3ListCountriesResponse Up

countries (optional)

array[v3Country]

v3ListPortsResponse Up

ports (optional)

array[v3Port]

v3ListRegionsResponse Up

regions (optional)

array[v3Region]

v3ListRegionsWithPolygonResponse Up

regions (optional)

array[v3RegionWithPolygon]

v3ListSegmentsResponse Up

segments (optional)

array[v3Segment]

v3ListStoppageEventsRequest Up

imo (optional)

array[Integer] format: int32

startDate (optional)

String

endDate (optional)

String

format (optional)

String

v3ListStoppageEventsResponse Up

stoppageEvents (optional)

array[v3StoppageEvent]

csv (optional)

String

xlsx (optional)

String

v3ListTonnageZonesResponse Up

zones (optional)

array[v3Zone]

v3ListTonnageZonesWithPolygonsResponse Up

zones (optional)

array[v3ZoneWithPolygon]

v3ListVesselsRequest Up

dwt (optional)

array[Double] format: double

eta (optional)

array[String]

segment (optional)

array[String]

subSegment (optional)

array[String]

loadRegion (optional)

array[String]

loadCountry (optional)

array[String]

loadPort (optional)

array[String]

destinationRegion (optional)

array[String]

destinationCountry (optional)

array[String]

destinationPort (optional)

array[String]

destinationUnlocode (optional)

array[String]

cargoStatus (optional)

array[String]

ladenStatus (optional)

array[String]

ladenStatusDraught (optional)

array[String]

speed (optional)

array[Double] format: double

draught (optional)

array[Double] format: double

excludeUnknownDestination (optional)

Boolean

group (optional)

String

range (optional)

String

flowDate (optional)

String

commodity (optional)

array[String]

commodityGroup (optional)

array[String]

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)

array[String]

imo (optional)

array[Long] format: int64

portStatus (optional)

array[String]

excludeMpv (optional)

Boolean

limit (optional)

Long format: int64

hoursSinceLast (optional)

Long format: int64

format (optional)

String

v3ListVesselsResponse Up

vessels (optional)

array[v3Vessel3]

csv (optional)

String

xlsx (optional)

String

v3LiveStateRequest Up

dwt (optional)

array[Double] format: double

eta (optional)

array[String]

segment (optional)

array[String]

subSegment (optional)

array[String]

loadRegion (optional)

array[String]

loadCountry (optional)

array[String]

loadPort (optional)

array[String]

destinationRegion (optional)

array[String]

destinationCountry (optional)

array[String]

destinationPort (optional)

array[String]

destinationUnlocode (optional)

array[String]

cargoStatus (optional)

array[String]

ladenStatus (optional)

array[String]

ladenStatusDraught (optional)

array[String]

speed (optional)

array[Double] format: double

draught (optional)

array[Double] format: double

excludeUnknownDestination (optional)

Boolean

group (optional)

String

range (optional)

String

flowDate (optional)

String

commodity (optional)

array[String]

commodityGroup (optional)

array[String]

boundingBox (optional)

v3BoundingBox

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)

array[String]

imo (optional)

array[Long] format: int64

portStatus (optional)

array[String]

excludeMpv (optional)

Boolean

limit (optional)

Long format: int64

hoursSinceLast (optional)

Long format: int64

format (optional)

String

vesselFilter (optional)

filtersVesselFilter

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)

v3GeoPoint

v3MarineProtectedAreaStay Up

mpaId (optional)

Integer format: int32

mpaName (optional)

String

countryCode (optional)

String

imo (optional)

Integer format: int32

vesselName (optional)

String

enteredAt (optional)

String

exitedAt (optional)

String

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)

String

endDate (optional)

String

v3MpaSummaryRow Up

imo (optional)

Integer format: int32

vesselName (optional)

String

startDate (optional)

String

endDate (optional)

String

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)

String

berthName (optional)

String

countryCode (optional)

String

unlocode (optional)

String

entityType (optional)

String

alias (optional)

String

v3Polygon1 Up

layerId (optional)

String

polygonId (optional)

String

polygonName (optional)

String

metadata (optional)

map[String, String]

v3PolygonParams Up

polygonName (optional)

String

geojson (optional)

String

metadata (optional)

map[String, String]

v3Polygons Up

polygons (optional)

array[v3Polygon1]

polygonsInLayer (optional)

Integer format: int32

v3Port Up

portId (optional)

Integer format: int32

portName (optional)

String

countryCode (optional)

String

region (optional)

String

unlocode (optional)

String

unlocodeAlias (optional)

array[String]

portNameAlias (optional)

array[String]

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)

String

regionName (optional)

String

v3RegionWithPolygon Up

regionId (optional)

String

regionName (optional)

String

geojson (optional)

String

v3SearchPolygonsResponse Up

polygons (optional)

array[v3Polygon]

v3SearchVesselsResponse Up

vessels (optional)

array[v3Vessel]

v3Segment Up

segment (optional)

String

segmentKey (optional)

String

subSegment (optional)

String

segmentInt (optional)

Integer format: int32

subSegmentInt (optional)

Integer format: int32

subSegmentKey (optional)

String

cutoffLow (optional)

Double format: double

cutoffHigh (optional)

Double format: double

platform (optional)

String

highlevelType (optional)

String

v3SegmentData Up

subSegment (optional)

String

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)

String

endedAt (optional)

String

portId (optional)

Integer format: int32

portName (optional)

String

zoneId (optional)

Integer format: int32

zoneName (optional)

String

minSpeedObserved (optional)

Double format: double

durationHours (optional)

Double format: double

lat (optional)

Double format: double

lon (optional)

Double format: double

classification (optional)

String

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 &quot;default&quot;, if no grouping was specified in the query.

rows (optional)

array[v3TimeseriesRow]

v3TimeseriesGroup1 - Port call timeseries group Up

group (optional)

String Name of the group. This will be &quot;default&quot;, 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 &quot;default&quot;, 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 &quot;default&quot;, 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)

String

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: [&quot;asc&quot;,&quot;desc&quot;].

format (optional)

String The return format of the data [&quot;csv&quot;,&quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

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 &quot;csv&quot;.

xlsx (optional)

String Link to download excel file, if format was specified to be &quot;xlsx&quot;.

v3TonnageTimeseriesGroup - Tonnage zone/fleet speed timeseries group Up

group (optional)

String Name of the group. This will be &quot;default&quot;, 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)

String

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>[&quot;daily&quot;, &quot;weekly&quot;, &quot;monthly&quot;,&quot;quarterly&quot;, &quot;yearly&quot;]</strong>. Default value is &quot;monthly&quot;. 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 **[&quot;export&quot;,&quot;import&quot;]. Default value is &quot;export&quot;. 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)

array[String]

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 [&quot;csv&quot;, &quot;json&quot;, &quot;xlsx&quot;]. Default is &quot;json&quot;.

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: [&quot;volume&quot;,&quot;count&quot;,&quot;ton_mile_calculated&quot;,&quot;ton_mile_actual&quot;,&quot;average_haul&quot;,&quot;average_speed&quot;, &quot;volume_times_duration&quot;]. Default is &quot;volume&quot;.

parceling (optional)

array[String] List of parceling statuses to retrieve. Allowed values are: [&quot;include&quot;,&quot;exclude&quot;,&quot;only&quot;].

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: [&quot;asc&quot;,&quot;desc&quot;].

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)

filtersVesselFilter

v3TradeLaneMetric Up

group (optional)

String

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)

String

segment (optional)

String

subSegment (optional)

String

dwt (optional)

Double format: double

maxDraught (optional)

Double format: double

name (optional)

String

exName (optional)

String

built (optional)

Long format: int64

type (optional)

String

mpv (optional)

Boolean

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)

v3VesselStatus

stoppageEvents (optional)

array[v3VesselStoppageEvent] Vessel speed events (stopage data).

v3Vessel2 Up

vesselName (optional)

String

imo (optional)

Long format: int64

mmsi (optional)

Long format: int64

lastPositionReceived (optional)

String

lastStaticReceived (optional)

String

dwt (optional)

Double format: double

segment (optional)

String

subSegment (optional)

String

zoneId (optional)

Long format: int64

zoneName (optional)

String

portId (optional)

Long format: int64

portName (optional)

String

anchorageId (optional)

Long format: int64

anchorageName (optional)

String

berthId (optional)

Long format: int64

berthName (optional)

String

shipyardId (optional)

Long format: int64

shipyardName (optional)

String

relatedPortId (optional)

Long format: int64

relatedPortName (optional)

String

cargoStatus (optional)

String

ladenStatus (optional)

String

ladenStatusDraught (optional)

String

destination (optional)

String

destinationPortName (optional)

String

destinationRegion (optional)

String

destinationCountryCode (optional)

String

eta (optional)

String

navigationalStatus (optional)

Long format: int64

lastPortName (optional)

String

lastCountryCode (optional)

String

lastRegion (optional)

String

portCallStatus (optional)

String

commodityGroup (optional)

String

commodityName (optional)

String

direction (optional)

String

speed (optional)

Double format: double

v3Vessel3 Up

vesselName (optional)

String

imo (optional)

Long format: int64

mmsi (optional)

Long format: int64

lastPositionReceived (optional)

String

lastStaticReceived (optional)

String

dwt (optional)

Double format: double

segment (optional)

String

subSegment (optional)

String

zoneId (optional)

Long format: int64

zoneName (optional)

String

portId (optional)

Long format: int64

portName (optional)

String

anchorageId (optional)

Long format: int64

anchorageName (optional)

String

berthId (optional)

Long format: int64

berthName (optional)

String

shipyardId (optional)

Long format: int64

shipyardName (optional)

String

relatedPortId (optional)

Long format: int64

relatedPortName (optional)

String

cargoStatus (optional)

String

ladenStatus (optional)

String

ladenStatusDraught (optional)

String

destination (optional)

String

destinationPortName (optional)

String

destinationRegion (optional)

String

destinationCountryCode (optional)

String

eta (optional)

String

navigationalStatus (optional)

Long format: int64

lastPortName (optional)

String

lastCountryCode (optional)

String

lastRegion (optional)

String

portCallStatus (optional)

String

commodityGroup (optional)

String

commodityName (optional)

String

direction (optional)

String

speed (optional)

Double format: double

v3VesselGeoObject Up

imo (optional)

Long format: int64

mmsi (optional)

Long format: int64

vesselName (optional)

String

course (optional)

Double format: double

speed (optional)

Double format: double

ladenStatus (optional)

String

geomCoordinates (optional)

String

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)

array[v3BerthStay]

anchorageStays (optional)

array[v3AnchorageStay]

vesselStatus (optional)

String

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)

String

data (optional)

array[v3TimeIntervalData]

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)

String

portId (optional)

Long format: int64

portName (optional)

String

anchorageId (optional)

Long format: int64

anchorageName (optional)

String

berthId (optional)

Long format: int64

berthName (optional)

String

shipyardId (optional)

Long format: int64

shipyardName (optional)

String

relatedPortId (optional)

Long format: int64

relatedPortName (optional)

String

vesselStatus (optional)

String

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)

String

destinationPortId (optional)

Long format: int64

destinationPortName (optional)

String

destinationRegion (optional)

String

destinationCountryCode (optional)

String

destinationScore (optional)

Double format: double

predictedDestinationPortId (optional)

Long format: int64

predictedDestinationPortName (optional)

String

predictedDestinationRegion (optional)

String

predictedDestinationCountryCode (optional)

String

predictedDestinationScore (optional)

Double format: double

eta (optional)

String

navigationalStatus (optional)

String

navigationalStatusCode (optional)

Long format: int64

portCallStatus (optional)

String

commodityId (optional)

Long format: int64

commodityGroup (optional)

String

commodityName (optional)

String

direction (optional)

String

speedStatus (optional)

String

lastVisitedPortId (optional)

Long format: int64

lastVisitedPortName (optional)

String

lastOpsPortId (optional)

Long format: int64

lastOpsPortName (optional)

String

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)

String

cargoStatus (optional)

String

portCallStatus (optional)

String

relatedPortName (optional)

String

draughtPercentage (optional)

Double format: double

destination (optional)

String

destinationPortName (optional)

String

lastPositionReceivedAt (optional)

String

lastStaticReceivedAt (optional)

String

currentSpeed (optional)

Double format: double

currentNavigationalStatus (optional)

Integer format: int32

currentCommodityGroup (optional)

String

v3VesselStoppageEvent Up

startedAt (optional)

String

endedAt (optional)

String

portId (optional)

Integer format: int32

portName (optional)

String

zoneId (optional)

Integer format: int32

zoneName (optional)

String

minSpeedObserved (optional)

Double format: double

durationHours (optional)

Double format: double

lat (optional)

Double format: double

lon (optional)

Double format: double

classification (optional)

String

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)

array[v3VesselGeoObject]

v3VesselsResponse Up

vessels (optional)

array[v3Vessel2]

csv (optional)

String

xlsx (optional)

String

v3Zone Up

zoneId (optional)

Integer format: int32

zoneName (optional)

String

v3ZoneBySegment Up

zoneName (optional)

String

data (optional)

array[v3SegmentData]

v3ZoneByTime Up

zoneName (optional)

String

data (optional)

array[v3TimeIntervalData]

v3ZoneChangesTimeseriesGroup - Tonnage zone/fleet speed timeseries group Up

group (optional)

String Name of the group. This will be &quot;default&quot;, 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)

String

zoneBasin (optional)

String

geomPolygonWkt (optional)

String

geomPolygonGeojson (optional)

String

geomCoordinateWkt (optional)

String

geomCoordinateGeojson (optional)

String

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.