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: APIClient)[source]
The
FleetGrowthTimeseriesreturns timeseries on fleet growth.
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
- segment
List of vessel segments to filter on. Allowed values can be obtained from the /entities/segments endpoint. 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.
- Type
- metric
The metric to retrieve for timeseries aggregations. Allowed values: [“count”,”dwt”]. Default is “count”.
- Type
- format_
The return format of the data [“csv”,”json”, “xlsx”]. Default is “json”.
- Type
- exclude_mpv
Flag to specify whether or not MPV vessels should be included/excluded. Default is to include.
- Type
- sort
Specifies whether results should be sorted in ascending or descing order. Allowed values: [“asc”,”desc”].
- Type
- start_date
The UTC start date of the date filter.
- Type
- end_date
The UTC end date of the date filter.
- Type
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
MutableSequence[oceanbolt.com.tonnage_v3.types.FleetGrowthTimeseriesGroup]
- 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
- rows
Rows of timeseries data.
- Type
MutableSequence[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
- scrapped
Number of vessels (or sum of DWT) that was scrapped during this period.
- delivered
Number of vessels (or sum of DWT) that was delivered during this period.
- net
Net number of vessels (or sum of DWT) that was added to/removed from the fleet during this period.