Historical Drydock Stays

Retrieve list of historical drydock stays for specific vessels or ports.

Example questions that can be answered with this endpoint:

• When did vessel XYZ last visit a dry dock?

class oceanbolt.sdk.data.dry_dock.DryDockHistoricalStays(client: APIClient)

The DryDockHistoricalStays returns list of historical dry dock stays.

get(**kwargs)

Retrieves historical dry dock data as a pandas.DataFrame

Example

When did vessel XYZ last visit a dry dock?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.dry_dock import DryDockHistoricalStays


base_client = APIClient("<token>")
df = DryDockHistoricalStays(base_client).get(
    imo=[9515644],
)

Returns:

shipyardStayId	imo	vesselName	segment	subsegment	dwt	portId	portName	portUnlocode	countryCode	region	shipyardName	shipyardId	arrivedAt	departedAt	durationDays
9515644#2016-06-27T09:39:58Z	9515644	POAVOSA WISDOM	Handysize	Large Handysize (27-43k)	28324	154	Chittagong	BDCGP	BD	ECINDIA	Chittagong Shipyard	13378	2016-06-27 09:39:58+00	2016-07-01 03:29:50+00	3.7429629629166663
9515644#2017-06-22T07:57:08Z	9515644	POAVOSA WISDOM	Handysize	Large Handysize (27-43k)	28324	2259	Tuzla	TRTUZ	TR	EASTMED	Tuzla Shipyard	6130	2017-06-22 07:57:08+00	2017-07-02 20:55:16+00	10.540370370324075
9515644#2019-04-28T09:57:55Z	9515644	POAVOSA WISDOM	Handysize	Large Handysize (27-43k)	28324	403	Kemen Port	CNLNJ	CN	FAREAST	Kemen Shipyard	9253	2019-04-28 09:57:55+00	2019-05-11 04:35:31+00	12.776111111064814

Arguments

class oceanbolt.com.drydock_v3.types.GetDryDockStaysRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

DryDockstays

imo

List of unique vessel identifiers (IMO numbers). This allows filtering to show data only for a subset of vessels. Example: [1234567,7654321].

Type:

MutableSequence[int]

port_id

This filters on the port where the vessel is currently in dry dock.

Type:

MutableSequence[int]

shipyard_id

List of Oceanbolt shipyard ids to filter on.

Type:

MutableSequence[int]

unlocode

UNLOCODE of the port.

Type:

MutableSequence[str]

segment

List of vessel segments to filter on.

Type:

MutableSequence[str]

sub_segment

List of vessel sub segments to filter on.

Type:

MutableSequence[str]

start_date

The UTC start date of the date filter

Type:

str

end_date

The UTC end date of the date filter

Type:

str

latest_only

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.

Type:

bool

format_

The return format of the data [“csv”,”json”, “xlsx”]. Default is “json”.

Type:

str

sort

Specifies whether results should be sorted in ascending or descing order. Allowed values: [“asc”,”desc”].

Type:

str

group_by

Determines the grouping of the timeseries data. This parameter only applies to the /drydock/timeseries endpoint.

Type:

str

Response

class oceanbolt.com.drydock_v3.types.GetDryDockStaysResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

data

Type:

MutableSequence[oceanbolt.com.drydock_v3.types.HistoricalDryDockStay]

csv

Type:

str

xlsx

Type:

str

previous_token

Type:

str

next_token

Type:

str

max_results

Type:

int

class oceanbolt.com.drydock_v3.types.HistoricalDryDockStay(mapping=None, *, ignore_unknown_fields=False, **kwargs)

shipyard_stay_id

Unique ID for the dry dock stay. This will always be unique to the port call.

Type:

str

imo

IMO number of the vessel.

Type:

int

mmsi

MMSI number of the vessel.

Type:

int

vessel_name

Name of the vessel.

Type:

str

segment

Segment of the vessel.

Type:

str

subsegment

Sub segment of the vessel.

Type:

str

dwt

DWT of the vessel

Type:

float

port_id

Oceanbolt database identifier of the port.

Type:

int

port_name

Name of the port.

Type:

str

unlocode

UNLOCODE of the port.

Type:

str

country_code

Country code of the port.

Type:

str

region

Region of the port.

Type:

str

shipyard_name

Name of the shipyard

Type:

str

shipyard_id

Oceanbolt database identifier of the shipyard.

Type:

int

arrived_at

UTC timestamp for when the vessel arrived at the port.

Type:

str

departed_at

UTC timestamp for when the vessel left the port.

Type:

str

duration_days

Duration of the dry dock stay (in days).

Type:

google.protobuf.wrappers_pb2.DoubleValue