Fleet Utilization Series
Aggregated from Fleet Utilization Vessels
Note
available on platforms : Platform.Liquids, Platform.LNG, Platform.LPG, Platform.Dry
- class kpler.sdk.resources.fleet_utilization_series.FleetUtilizationSeries(configuration, column_ids=True, log_level=None)[source]
The
FleetUtilizationSeries
endpoint returns current and historical supply & demand capacity balance, total,loaded & ballast capacity evolution and capacity available by products.- get(start_date=None, end_date=None, zones=None, metric=None, period=None, split=None, products=None, unit=None, vessel_types_cpp=None, vessel_types_oil=None, vessel_states=None, percent=None, gte=None, lte=None, vessel_types=None, previous_zones=None, next_zones=None, vessel_directions=None, distinct_aggregation=False)[source]
- Parameters
start_date – Optional[date] Start of the period (YYYY-MM-DD)
end_date – Optional[date] End of the period (YYYY-MM-DD)
zones – Optional[List[str]] Names of countries/geographical zones
metric – Optional[Enum]
FleetUtilizationSeriesMetric
period – Optional[Enum]
FleetUtilizationSeriesPeriod
split – Optional[Enum]
FleetUtilizationSeriesSplit
products – Optional[List[str]] Names of products
unit – Optional[Enum]
FleetUtilizationSeriesUnit
vessel_types_cpp – Optional[List[Enum]]
VesselTypesCPP
vessel_types_oil – Optional[List[Enum]]
VesselTypesOil
vessel_states – Optional[List[Enum]]
FleetUtilizationSeriesVesselsState
percent – Optional[bool] Access percentage of loaded vessels over ballast vessels
gte – Optional[int] Get vessels with deadweight/capacity greater or equals to this value by default 0
lte – Optional[int] Get vessels with deadweight/capacity lower or equals to this value by default 606550
vessel_types – Optional[List[Enum]]
VesselTypesDry
VesselTypesLNG
VesselTypesLPG
previous_zones – Optional[List[str]] Names of zones (port/region/country/continent) the vessel is coming from
next_zones – Optional[List[str]] Names of zones (port/region/country/continent) the vessel is going to
vessel_directions – Optional[List[str]] Names of the vessel’s course of direction on the given day
distinct_aggregation – Option[bool] Show or hide distinct vessels by default false
Examples
>>> from datetime import date ... from kpler.sdk.resources.fleet_utilization_series import FleetUtilizationSeries ... from kpler.sdk import FleetUtilizationSeriesMetric, FleetUtilizationSeriesPeriod,FleetUtilizationSeriesSplit, FleetUtilizationSeriesUnit ... fleet_utilization_series_client = FleetUtilizationSeries(config) ... fleet_utilization_series_client.get( ... start_date=date(2020,10,1), ... end_date=date(2020,11,1), ... zones=["Japan"], ... metric=FleetUtilizationSeriesMetric.Count, ... period=FleetUtilizationSeriesPeriod.Daily, ... split=FleetUtilizationSeriesSplit.Product, ... unit=FleetUtilizationSeriesUnit.MT ... )
Date
Clean Products
crude/co
DPP
NPC
Other
2020-10-01
114
62
31
37
13
2020-10-02
114
60
36
40
14
2020-10-03
104
59
38
43
12
2020-10-04
105
55
38
42
13
2020-10-05
109
60
40
42
13
2020-10-06
100
61
37
36
14
2020-10-07
103
52
31
30
14
2020-10-08
105
38
33
24
13
2020-10-09
109
46
31
17
11
2020-10-10
115
48
35
21
10
…
…
…
…
…
…
- class kpler.sdk.FleetUtilizationSeriesMetric(value)[source]
- Count = 'count'
- DeadWeight = 'deadWeight'
- class kpler.sdk.FleetUtilizationSeriesPeriod(value)[source]
- Annually = 'years'
- Daily = 'days'
- Monthly = 'months'
- Quarterly = 'quarters'
- Weekly = 'weeks'
- class kpler.sdk.FleetUtilizationSeriesSplit(value)[source]
- CurrentContinents = 'currentContinents'
- CurrentCountries = 'currentCountries'
- CurrentSeas = 'currentSeas'
- CurrentSubContinents = 'currentSubcontinents'
- CurrentSubregions = 'currentSubregions'
- Direction = 'direction'
- NextContinents = 'nextContinents'
- NextCountries = 'nextCountries'
- NextPorts = 'nextPorts'
- NextSubContinents = 'nextSubContinents'
- NextTradingRegions = 'nextTradingRegions'
- PreviousContinents = 'previousContinents'
- PreviousCountries = 'previousCountries'
- PreviousPorts = 'previousPorts'
- PreviousSubContinents = 'previousSubContinents'
- PreviousTradingRegions = 'previousTradingRegions'
- Product = 'product'
- State = 'state'
- SubState = 'subState'
- Total = 'total'
- VesselType = 'vesselType'
- VesselTypeCpp = 'vesselTypeCpp'
- VesselTypeOil = 'vesselTypeOil'
- class kpler.sdk.VesselTypesCPP(value)[source]
- GP = 'GP'
- LR1 = 'LR1'
- LR2 = 'LR2'
- LR3 = 'LR3'
- MR = 'MR'
- SmallTanker = 'Small Tanker'
- VLCC = 'VLCC'
- class kpler.sdk.VesselTypesOil(value)[source]
- Aframax = 'Aframax'
- Panamax = 'Panamax'
- ProductTanker = 'Product Tanker'
- SmallTanker = 'Small Tanker'
- Suezmax = 'Suezmax'
- ULCC = 'ULCC'
- VLCC = 'VLCC'
- class kpler.sdk.VesselTypesLNG(value)[source]
- LLowerConventional = 'L (Lower Conventional)'
- MMedMax = 'M (Med Max)'
- QFlex = 'Q-Flex'
- QMax = 'Q-Max'
- SSmallSCale = 'S (Small Scale)'
- XLUpperConventional = 'XL (Upper Conventional)'
- XSPressureGas = 'XS (Pressure Gas)'
- class kpler.sdk.VesselTypesLPG(value)[source]
- Handysize = 'Handysize'
- LGC = 'LGC'
- MGC = 'MGC'
- SGC = 'SGC'
- VLEC = 'VLEC'
- VLGC = 'VLGC'
- class kpler.sdk.VesselTypesDry(value)[source]
- BabyCapes = 'Baby Capes'
- Capesize = 'Capesize'
- Handymax = 'Handymax'
- Handysize = 'Handysize'
- Kamsarmax = 'Kamsarmax'
- Newcastlemax = 'Newcastlemax'
- Panamax = 'Panamax'
- PostPanamax = 'Post-Panamax'
- Supramax = 'Supramax'
- Ultramax = 'Ultramax'
- VLOC = 'VLOC'
- Valemax = 'Valemax'