Fleet Metrics Series

Aggregated from Fleet Metrics Vessels

Note

available on platforms : Platform.Liquids, Platform.LPG, Platform.LNG

class kpler.sdk.resources.fleet_metrics.FleetMetrics(configuration, column_ids=True, log_level=None)

The FleetMetrics endpoint provides you with aggregated fleet data per day or week, either the floating storage or all the loaded vessels.

get(start_date=None, end_date=None, zones=None, metric=None, period=None, floating_storage_duration_min=None, floating_storage_duration_max=None, products=None, unit=None, split=None, with_freight_view=False, vessel_types=None, vessel_types_alt=None)

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] FleetMetricsAlgo

• period – Optional[Enum] FleetMetricsPeriod

• floating_storage_duration_min – Optional[str] Minimum floating days [7-10-12-15-20-30-90] or [1-3-5-7-10-12-15-20-30-90] on LNG platform

• floating_storage_duration_max – Optional[str] Maximum floating days [7-10-12-15-20-30-90-Inf] or [1-3-5-7-10-12-15-20-30-90-Inf] on LNG platform

• products – Optional[List[str]] Names of products. Not available on LNG platform

• unit – Optional[Enum] FleetMetricsMeasurementUnit by default return in bbl unit or cm on LNG platform

• split – Optional[Enum] FleetMetricsSplit

• with_freight_view – bool By default: with_freight_view=False. Provides access to the entire fleet’s trades, irrespective of your current cargo subscription. Only available via Freight subscription.

• vessel_types – Optional[List[str]] = Names of vessel types

• vessel_types_alt – Optional[List[str]] = Names of vessel types for oil liquids platform only

Examples

>>> from kpler.sdk.resources.fleet_metrics import FleetMetrics
... from kpler.sdk import FleetMetricsAlgo, FleetMetricsSplit, FleetMetricsPeriod
... fleet_metrics_client = FleetMetrics(config)
... fleet_metrics_client.get(
...     metric=FleetMetricsAlgo.LoadedVessels,
...     zones=["China"],
...     period=FleetMetricsPeriod.Daily,
...     split=FleetMetricsSplit.CurrentSubregions
... )

Date	Hubei	Jiangsu Province	Anhui	Shanghai Province	Liaoning	Zhejiang	Hainan	Hunan	Fujian	…
2019-10-27	0.0	5162437.50	0.00	2701888.77	11170477.14	13718894.53	713446.92	0.0	3467654.33	…
2019-10-28	0.0	4570962.59	0.00	3004283.99	10789081.90	13882417.02	1083772.10	0.0	2644236.36	…
2019-10-29	0.0	6341355.57	149716.36	4651774.07	11371285.63	14548268.95	1672749.96	0.0	4543149.04	…
2019-10-30	0.0	4157074.18	0.00	2306649.65	14003942.45	13719347.39	1443052.37	0.0	2017324.65	…
2019-10-31	0.0	4251597.45	0.00	4825448.32	10310188.30	13959762.82	3180612.54	0.0	2523402.81	…

class kpler.sdk.FleetMetricsAlgo(value)

FloatingStorage = 'floating_storage'

LoadedVessels = 'loaded_vessels'

class kpler.sdk.FleetMetricsPeriod(value)

Daily = 'daily'

EIA = 'eia'

Weekly = 'weekly'

class kpler.sdk.FleetMetricsMeasurementUnit(value)

BBL = 'bbl'

CM = 'cm'

T = 't'

class kpler.sdk.FleetMetricsSplit(value)

Buyer = 'buyer'

Charterers = 'charterers'

CrudeQuality = 'crude quality'

CurrentContinents = 'current continents'

CurrentCountries = 'current countries'

CurrentSeas = 'current seas'

CurrentSubcontinents = 'current subcontinents'

CurrentSubregions = 'current subregions'

DestinationCountries = 'destination countries'

DestinationInstallations = 'destination installations'

FloatingDays = 'floating days'

Grades = 'grades'

OriginCountries = 'origin countries'

OriginInstallations = 'origin installations'

Products = 'products'

Seller = 'seller'

Total = 'total'

TradeStatus = 'trade status'

VesselType = 'vessel type'