Fleet Metrics Vessels

Note

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

class kpler.sdk.resources.fleet_metrics_vessels.FleetMetricsVessels(configuration, column_ids=True, log_level=None)

The FleetMetricsVessels endpoint provides the list of vessels with their cargo per day on a given period, for the Floating Storage or the Loaded Vessels metrics, and their location.

get(start_date=None, end_date=None, zones=None, metric=None, floating_storage_duration_min=None, floating_storage_duration_max=None, products=None, unit=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[str] Names of countries/geographical zones

• metric – Enum FleetMetricsVesselsAlgo

• 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[str] Names of products. Not available on LNG platform

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

• 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[Enum]] = Vessel types, pick types based on platform.

• vessel_types_alt – Optional[List[Enum]] = For oil vessel types, only available for Liquids

Examples

>>> from datetime import date
... from kpler.sdk.resources.fleet_metrics_vessels import FleetMetricsVessels
... from kpler.sdk import FleetMetricsVesselsAlgo,FleetMetricsVesselsMeasurementUnit
... fleet_metrics_vessels_client=FleetMetricsVessels(config)
... fleet_metrics_vessels_client.get(
...     metric=FleetMetricsVesselsAlgo.LoadedVessels,
...     zones=["China"],
...     start_date=date(2020,10,1),
...     end_date=date(2020,10,31),
...     floating_storage_duration_min="7",
...     floating_storage_duration_max="10",
...     products=["Dirty"],
...     unit=FleetMetricsVesselsMeasurementUnit.BBL
... )

Date	IMO	Name	Dead Weight Tonnage	Quantity (bbl)	Family	Group	Product	Grade	Current Continent	…
2020-10-01	9376749	Advantage Value	297557	1057204	Dirty	crude/co	crude	Iracema	Asia	…
2020-10-01	9430313	Afra Royal	115948	530973	Dirty	crude/co	crude	Hamaca	Asia	…
2020-10-01	9759836	Agios Sostis I	299983	2000003	Dirty	crude/co	crude	Arab Hy.	Asia	…
2020-10-01	9653410	Al Derwazah	316884	2000003	Dirty	crude/co	crude	Kuwait	Asia	…
2020-10-01	9329708	Al Jabriyah Ii	317570	2000003	Dirty	crude/co	crude	Kuwait	Asia	…
…	…	…	…	…	…	…	…	…	…	…

class kpler.sdk.FleetMetricsVesselsAlgo(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

FloatingStorage = 'floating_storage'

LoadedVessels = 'loaded_vessels'

class kpler.sdk.FleetMetricsVesselsMeasurementUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

BBL = 'bbl'

CM = 'cm'

KB = 'kb'

KT = 'kt'

MMBBL = 'mmbbl'

MT = 'mt'

T = 't'

class kpler.sdk.VesselTypesCPP(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

GP = 'GP'

LR1 = 'LR1'

LR2 = 'LR2'

LR3 = 'LR3'

MR = 'MR'

SmallTanker = 'Small Tanker'

VLCC = 'VLCC'

class kpler.sdk.VesselTypesLNG(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

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, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Handysize = 'Handysize'

LGC = 'LGC'

MGC = 'MGC'

SGC = 'SGC'

VLEC = 'VLEC'

VLGC = 'VLGC'

class kpler.sdk.VesselTypesOil(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Aframax = 'Aframax'

Panamax = 'Panamax'

ProductTanker = 'Product Tanker'

SmallTanker = 'Small Tanker'

Suezmax = 'Suezmax'

ULCC = 'ULCC'

VLCC = 'VLCC'