This API provides access to the data available in the Oceanbolt Data Platform. The API is accessible on the following base url: https://api.oceanbolt.com/v3

Introduction

This API is documented in OpenAPI format. The API allows for programmatic access to the different data resources that are also accessible in the Oceanbolt Data Platform. The resources are grouped into the following categories:

• Congestion: congestion data

• Tonnage: tonnage and speed related data

• Trade Flows: trade flow data

• Dry dock: individual dry dock stays on the vessel level and summary timeseries for dry dockings

• Port Calls: Historic list of port calls on either vessel/port level

• Entities: listing of various database entities in the Oceanbolt Platform

• Fleet Management: management user defined fleets

• Polygon Management: management user defined polygon layers

Detailed information on how to query and filter the data is available in the documentation on the individual endpoints.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Authentication to the Oceanbolt Data API is done through bearer token. To make calls to the API, send the API token in the Authorization HTTP header using the Bearer authentication scheme. You can create access tokens from your profile page on: Oceanbolt Data Platform. Access tokens should be provided as a bearer token, e.g. it should be in the form of a header with the following format:

Authorization: Bearer <TOKEN>

Base url

Base url:

https://api.oceanbolt.com

More information: https://openapi.oceanbolt.com

Contact Info: support@oceanbolt.com

^{Version: 3.0.0}

^{All rights reserved}

^{http://apache.org/licenses/LICENSE-2.0.html}

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)