Fleet Growth

Find weekly/monthly/annual fleet growth numbers for any vessel segment.

Example questions that can be answered with this endpoint:

  • How many supramax vessels was delivered/scrapped in 2020 on a monthly basis?

  • What was total annual fleet growth over the past 5 years?

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

The FleetGrowthTimeseries returns timeseries on fleet growth.

get(**kwargs)[source]

Retrieves timeseries data as a pandas.DataFrame

Example

How many supramax vessels was delivered/scrapped in 2020 on a monthly basis?

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


base_client = APIClient()
df = FleetGrowthTimeseries(base_client).get(
    segment=['supramax'],
    start_date = date(2020,1,1),
    end_date = date(2020,12,31)
)

Returns:

date

scrapped

delivered

net

2020-01-06

0

4

4

2020-01-13

1

3

2

2020-01-20

0

2

2

2020-01-27

0

4

4

2020-02-03

1

1

0

2020-02-10

1

0

-1

2020-02-24

1

1

0

2020-03-02

0

1

1

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.GetTonnageFleetGrowthResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Response object for GetTonnageFleetGrowth

timeseries

Timeseries data groups.

Type

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

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.FleetGrowthTimeseriesGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Fleet growth 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.FleetGrowthTimeseriesRow]

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

Fleet growth timeseries row

date

UTC date timestamp of the timeseries row.

Type

str

scrapped

Number of vessels (or sum of DWT) that was scrapped during this period.

Type

google.protobuf.wrappers_pb2.DoubleValue

delivered

Number of vessels (or sum of DWT) that was delivered during this period.

Type

google.protobuf.wrappers_pb2.DoubleValue

net

Net number of vessels (or sum of DWT) that was added to/removed from the fleet during this period.

Type

google.protobuf.wrappers_pb2.DoubleValue