Ballast Capacity Series

Aggregated from Ballast Capacity Port Calls

Note

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

class kpler.sdk.resources.ballast_capacity_series.BallastCapacitySeries(configuration, column_ids=True, log_level=None)

The BallastCapacitySeries endpoint returns daily/ weekly/ monthly aggregated data values for a given zone/ vessel type/ time period /last product carried.

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, 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] BallastCapacitySeriesMetric

• period – Optional[Enum] BallastCapacitySeriesPeriod

• split – Optional[Enum] BallastCapacitySeriesSplit

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

• unit – Optional[Enum] BallastCapacitySeriesUnit

• 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

• 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 kpler.sdk.resources.ballast_capacity_series import BallastCapacitySeries
... from kpler.sdk import BallastCapacitySeriesMetric, BallastCapacitySeriesPeriod, BallastCapacitySeriesSplit
... ballast_capacity_series_client = BallastCapacitySeries(config)
... ballast_capacity_series_client.get(
...     metric=BallastCapacitySeriesMetric.Capacity,
...     period=BallastCapacitySeriesPeriod.Daily,
...     split=BallastCapacitySeriesSplit.VesselType,
... )

Date	MR	GP	LR3	LR2	VLCC	LR1
2020-11-22	10724.0	NaN	NaN	NaN	NaN	NaN
2020-11-23	616555.0	2080981.0	1194773.0	1004319.0	163657.0	679003.0
2020-11-24	1287340.0	2944327.0	4162769.0	2826019.0	1340769.0	2647163.0
2020-11-25	854538.0	2975890.0	3930704.0	3186276.0	1226344.0	5675351.0
2020-11-26	803699.0	2393202.0	2431821.0	2325491.0	571266.0	2991957.0

class kpler.sdk.BallastCapacitySeriesMetric(value)

Capacity = 'capacity'

Count = 'count'

DeadWeight = 'deadWeight'

class kpler.sdk.BallastCapacitySeriesPeriod(value)

Daily = 'daily'

Monthly = 'monthly'

Weekly = 'weekly'

class kpler.sdk.BallastCapacitySeriesSplit(value)

Country = 'country'

Source = 'source'

Total = 'total'

VesselType = 'vesselType'

VesselTypeCpp = 'vesselTypeCpp'

VesselTypeOil = 'vesselTypeOil'

class kpler.sdk.BallastCapacitySeriesUnit(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'