Drydock Timeseries

Retrieve timeseries data of how many vessels have been drydocked in different ports, countries or regions over time.

Example questions that can be answered with this endpoint:

• How has the number of dry docked vessels changed over the past year?

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

The DryDockTimeseries returns a timeseries of historical dry dock stays.

get(**kwargs)

Retrieves dry dock timeseries data as a pandas.DataFrame

Example

How has the number of dry docked vessels changed over the past year?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.dry_dock import DryDockTimeseries
from datetime import date

base_client = APIClient("<token>")
df = DryDockTimeseries(base_client).get(
    start_date=date(2020,1,1),
)

Returns:

date	vesselCount	vesselDwt	avgWaitingDays	medianWaitingDays
2021-03-15	49	9357994	20.798795138888885	8.826215277777779
2021-03-16	51	9640308	20.094400190631806	8.920185185185185
2021-03-17	51	9519327	20.08614764887436	8.777407407407408
2021-03-18	53	9861875	20.20562631027253	9.663645833333334

Arguments

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

DryDock request object.

port_id

List of Oceanbolt port ids to filter on. This filters on the port where the vessel is currently in dry dock.

Type:

MutableSequence[int]

port_unlocode

List of five letter UNLOCODEs for to filter on.

Type:

MutableSequence[str]

shipyard_id

List of Oceanbolt shipyard ids to filter on. This filters on the shipyard where the vessel is currently in dry dock.

Type:

MutableSequence[int]

country_code

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.

Type:

MutableSequence[str]

region_id

The list of region IDs to get dry dock data for. Region ID can be obtained either from the /entities/regions endpoint.

Type:

MutableSequence[str]

segment

Cannot be supplied alongside subSegment

Type:

MutableSequence[str]

sub_segment

List of vessel sub segments to filter on. Allowed values can be obtained from the /entities/segments endpoint. Cannot be supplied alongside segment

Type:

MutableSequence[str]

group_by

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

Type:

str

exclude

60 days will be excluded from the returned data.

Type:

int

format_

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

Type:

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

last_n_days

Short hand parameter for quickly getting data for the last N days. Cannot be supplied along either start_date or end_date.

Type:

int

sort

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

Type:

str

display_date

Parameter used to display historical vessel lists for congested vessels. It is only applicable to the DryDockVessels method.

Type:

str

Response

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

DryDock timeseries row object.

date

UTC date timestamp of the timeseries row

Type:

str

vessel_count

Number of vessels that were congested on the date

Type:

google.protobuf.wrappers_pb2.Int32Value

vessel_dwt

Sum of DWT that were congested on the date

Type:

google.protobuf.wrappers_pb2.DoubleValue

avg_waiting_days

Average waiting days of vessels that were congested on the date

Type:

google.protobuf.wrappers_pb2.DoubleValue

median_waiting_days

Median waiting days of vessels that were congested on the date

Type:

google.protobuf.wrappers_pb2.DoubleValue

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

DryDock timeseries group object.

group

Name of the group. This will be “default”, if no grouping was specified in the query.

Type:

str

rows

Rows of timeseries data

Type:

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