Fleet Status

Find the development of the number of vessels on the water for any vessel segment.

Example questions that can be answered with this endpoint:

  • What is the current size of the “on the water dry bulk fleet split by segment?

  • How has the number of capesize vessels on the water developed over the past 5 years?

class oceanbolt.sdk.data.tonnage.FleetStatusTimeseries(client: oceanbolt.sdk.client.APIClient)[source]

The FleetStatusTimeseries returns timeseries on fleet status (number of vessels active in the fleet).

get(**kwargs)[source]

Retrieves timeseries data as a pandas.DataFrame

Example

How has the number of capesize vessels on the water developed over the past 4 years?

from oceanbolt.sdk.client import APIClient
from oceanbolt.sdk.data.tonnage import FleetStatusTimeseries
from datetime import date

base_client = APIClient()
df = FleetStatusTimeseries(base_client).get(
    segment = ["capesize"],
    group_by = "segment",
    start_date = date(2016,1,1),
    end_date = date(2020,12,31),
)

Returns:

group

date

value

Capesize

2016-01-01

1548

Capesize

2016-01-02

1548

Capesize

2016-01-03

1548

Capesize

2016-01-04

1548

Capesize

2016-01-05

1550

Capesize

2016-01-06

1550

Capesize

2016-01-07

1552

Capesize

2016-01-08

1554

Arguments

class oceanbolt.com.tonnage_v3.types.GetTonnageFleetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Request object for GetTonnageFleetStatus and GetTonnageFleetGrowth

frequency

Frequency determines the granularity/period grouping of the timeseries. Allowed values are: [“daily”, “weekly”, “monthly”,”quarterly “yearly”]. Default value is “monthly”.

Type

str

segment

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

Type

Sequence[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

Sequence[str]

group_by

Determines the grouping of the timeseries data.

Type

str

metric

The metric to retrieve for timeseries aggregations. Allowed values: [“count”,”dwt”]. Default is “count”.

Type

str

format_

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

Type

str

exclude_mpv

Flag to specify whether or not MPV vessels should be included/excluded. Default is to include.

Type

bool

sort

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

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

Response

class oceanbolt.com.tonnage_v3.types.GetTonnageFleetStatusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Response object for GetTonnageFleetStatus

timeseries

Timeseries data groups.

Type

Sequence[oceanbolt.com.tonnage_v3.types.TimeseriesGroup]

csv

Link to download csv file, if format was specified to be “csv”.

Type

str

xlsx

Link to download excel file, if format was specified to be “xlsx”.

Type

str

class oceanbolt.com.tonnage_v3.types.TonnageTimeseriesGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Tonnage zone/fleet speed timeseries group

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

Sequence[oceanbolt.com.tonnage_v3.types.TonnageTimeseriesRow]

class oceanbolt.com.tonnage_v3.types.TonnageTimeseriesRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Tonnage zone/fleet speed timeseries row.

date

UTC date timestamp of the timeseries row.

Type

str

vessel_count

The number of vessels for the timeseries row.

Type

google.protobuf.wrappers_pb2.Int32Value

vessel_dwt

The sum of dwt for the timeseries row.

Type

google.protobuf.wrappers_pb2.DoubleValue

avg_speed

The average speed in knots for the timeseries row.

Type

google.protobuf.wrappers_pb2.DoubleValue