Congestion Vessels

Note

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

class kpler.sdk.resources.congestion_vessels.CongestionVessels(configuration, column_ids=True, log_level=None)

The CongestionVessels endpoint returns current and historical waiting time for vessels spent in waiting areas before going to berth.

get(start_date=None, end_date=None, zones=None, products=None, vessel_types_cpp=None, vessel_types_oil=None, size=None, vessel_types=None, gte=None, lte=None, congestion_only=None, vessel_operation=None, waiting_duration_min=None, waiting_duration_max=None, with_freight_view=False, period=None, vessels=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

• products – Optional[List[str]] Names of products

• vessel_types_cpp – Optional[List[Enum]] VesselsTypesCpp

• vessel_types_oil – Optional[List[Enum]] VesselsTypesOil

• size – Optional[int] Maximum number of fleet utilization vessels returned

• vessel_types – Optional[List[Enum]] VesselsTypesDry VesselsTypesLNG VesselsTypesLPG

• 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

• congestion_only – bool Exclude vessels in the waiting zone not tagged as congestion (lays ups,open vessels,floating storage,distressed cargoes etc).Use [“true”, “false”]

• vessel_operation – CongestionVesselsOperation

• waiting_duration_min – Optional[int] Minimum waiting duration of vessel. Default to 0 days if not specified.

• waiting_duration_max – Optional[int] Maximum waiting duration of vessel. Default to 1000000 days if not specified.

• 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.

• period – Optional[Enum] CongestionVesselsPeriod

• vessels – Optional[List[str]] Names or IMOs of the vessels

Examples

>>> from datetime import date
... from kpler.sdk.resources.congestion_vessels import CongestionVessels
... congestion_vessels_client=CongestionVessels(config)
... congestion_vessels_client.get(
...         start_date=date(2020, 10, 1),
...         end_date=date(2020, 11, 1),
...         zones=["Japan"],
...         products=["gasoline", "DPP"]
...     )

Date (timestamp)	IMO	Name	Dead Weight Tonnage	Cargo(t)	Family	Group	Products	Installation	Port	…
2020-10-25	9392808	Alpine Mystery	49999	16521.72	DPP	NaN	NaN	Kawasaki Refinery	Kawasaki	…
2020-10-11	9317078	Haruna Express	45761	32449.03	Light Ends	Gasoline/Naphtha	Gasoline	Showa Yokkaichi Refinery	Yokkaichi	Japan	…
2020-10-31	9392808	Alpine Mystery	49999	21028.51	DPP	Fuel Oils	FO	Sakai Refinery	Osaka	…
2020-10-26	9392808	Alpine Mystery	49999	16521.72	DPP	NaN	NaN	Kawasaki Refinery	Kawasaki	…
2020-10-28	9290646	Torm Kansas	46922	16825.78	Light Ends	Gasoline/Naphtha	Gasoline	Showa Yokkaichi Refinery	Yokkaichi	…

get_columns()

This endpoint returns a recent and updated list of all columns available for the endpoint congestion vessels.

Examples

>>> from kpler.sdk.resources.congestion_vessels import CongestionVessels
... congestion_vessels_client=CongestionVessels(config)
... congestion_vessels_client.get_columns()

id	name	description	deprecated	type
date	Date	Day of vessel in the waiting zone	False	date yyyy-MM-dd
vessel_imo	IMO	IMO of the vessel	False	long
vessel	Name	Name of the vessel	False	string
vessel_dwt_tons	Dead Weight Tonnage	Dead Weight Tonnage	False	long
cargo_tons	Cargo (t)	Cargo in tons	False	double
…	…	…	…	…

Return type

DataFrame

class kpler.sdk.VesselTypesCPP(value)

GP = 'GP'

LR1 = 'LR1'

LR2 = 'LR2'

LR3 = 'LR3'

MR = 'MR'

SmallTanker = 'Small Tanker'

VLCC = 'VLCC'

class kpler.sdk.VesselTypesOil(value)

Aframax = 'Aframax'

Panamax = 'Panamax'

ProductTanker = 'Product Tanker'

SmallTanker = 'Small Tanker'

Suezmax = 'Suezmax'

ULCC = 'ULCC'

VLCC = 'VLCC'

class kpler.sdk.VesselTypesLNG(value)

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)

Handysize = 'Handysize'

LGC = 'LGC'

MGC = 'MGC'

SGC = 'SGC'

VLEC = 'VLEC'

VLGC = 'VLGC'

class kpler.sdk.VesselTypesDry(value)

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'

class kpler.sdk.CongestionVesselsOperation(value)

All = 'All'

Discharge = 'Discharge'

Load = 'Load'

class kpler.sdk.CongestionVesselsPeriod(value)

Annually = 'years'

Daily = 'days'

EIA = 'eia'

Monthly = 'months'

Quarterly = 'quarters'

Weekly = 'weeks'