Congestion Series

Aggregated from Congestion Vessels

Note

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

class kpler.sdk.resources.congestion_series.CongestionSeries(configuration, column_ids=True, log_level=None)

The CongestionSeries 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, metric=None, period=None, split=None, products=None, unit=None, vessel_types_cpp=None, vessel_types_oil=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)

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

• period – Optional[Enum] CongestionSeriesPeriod

• split – Optional[Enum] CongestionSeriesSplit

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

• unit – Optional[Enum] CongestionSeriesUnit

• vessel_types_cpp – Optional[List[Enum]] VesselTypesCPP

• vessel_types_oil – Optional[List[Enum]] VesselTypesOil

• vessel_types – Optional[List[Enum]] VesselTypesDry VesselTypesLNG VesselTypesLPG

• 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 – Optional[Enum] CongestionSeriesOperation

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

Examples

>>> from datetime import date
... from kpler.sdk.resources.congestion_series import CongestionSeries
... from kpler.sdk import CongestionSeriesMetric, CongestionSeriesPeriod, CongestionSeriesSplit
... congestion_series_client = CongestionSeries(config)
... congestion_series_client.get(
...     start_date=date(2020, 1, 1),
...     end_date=date(2020, 6, 1),
...     metric=CongestionSeriesMetric.Count,
...     period=CongestionSeriesPeriod.Monthly,
...     split=CongestionSeriesSplit.VesselType
... )

Date	MR	GP	LR3	LR2	VLCC	LR1
2020-01	6097	5636	742	2241	866	1022
2020-02	5683	5232	685	2094	831	944
2020-03	6145	5659	747	2223	905	1033
2020-04	5467	8006	676	2073	906	887
2020-05	5414	9446	650	2045	855	838
2020-06	170	268	21	72	22	22

class kpler.sdk.CongestionSeriesMetric(value)

Capacity = 'capacity'

Count = 'count'

DeadWeight = 'deadWeight'

Duration = 'duration'

class kpler.sdk.CongestionSeriesPeriod(value)

Annually = 'years'

Daily = 'days'

EIA = 'eia'

Monthly = 'months'

Quarterly = 'quarters'

Weekly = 'weeks'

class kpler.sdk.CongestionSeriesSplit(value)

Country = 'country'

Grade = 'grade'

Installation = 'installation'

Port = 'port'

Product = 'product'

Total = 'total'

VesselOperations = 'VesselOperations'

VesselType = 'vesselType'

VesselTypeCpp = 'vesselTypeCpp'

VesselTypeOil = 'vesselTypeOil'

WaitingStatus = 'waitingStatus'

class kpler.sdk.CongestionSeriesUnit(value)

KT = 'kt'

MT = 'mt'

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.CongestionSeriesOperation(value)

All = 'All'

Discharge = 'Discharge'

Load = 'Load'