Freight Metrics Series

Note

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

class kpler.sdk.resources.freight_metrics_series.FreightMetricsSeries(configuration, column_ids=True, log_level=None)

The FreightMetricsSeries endpoint returns demand metrics like tonmiles & tondays as well as other metrics like average speed for laden fleet and average distance under this metric

get(start_date=None, end_date=None, from_locations=None, to_locations=None, from_installations=None, to_installations=None, metric=None, vessel_types_cpp=None, vessel_types_oil=None, products=None, period=None, split=None, unit=None, with_intra_country=None, gte=None, lte=None, vessel_types=None, with_freight_view=False, avg_speed_min=None, avg_speed_max=None, status=None)

Parameters

• start_date – Optional[date] Start of the period (YYYY-MM-DD)

• end_date – Optional[date] End of the period (YYYY-MM-DD)

• from_locations – Optional[str] Names of locations

• to_locations – Optional[str] Names of locations

• from_installations – Optional[str] Names of installations

• to_installations – Optional[str] Names of installations

• metric – Optional[Enum] FreightMetricsSeriesMetric

• vessel_types_cpp – Optional[Enum] VesselTypesCPP

• vessel_types_oil – Optional[Enum] VesselTypesOil

• products – Optional[str] Names of products

• period – Optional[Enum] FreightMetricsSeriesPeriod

• split – Optional[Enum] FreightMetricsSeriesSplit

• unit – Optional[Enum] FreightMetricsSeriesUnit

• with_intra_country – Optional[bool] By default: false. Takes into account the freight metric series within the selected region. Use [“true”, “false”]

• 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

• vessel_types – Optional[Enum] VesselTypesDry VesselTypesLNG VesselTypesLPG

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

• avg_speed_min – Optional[int] Get vessel legs with average speed greater or equal to this value

• avg_speed_max – Optional[int] Get vessel legs with average speed less than or equal to this value

• status – Optional[Enum] FreightMetricsSeriesStatus

Examples

>>> from datetime import date
... from kpler.sdk.resources.freight_metrics_series import FreightMetricsSeries
... from kpler.sdk import FreightMetricsSeriesMetric, FreightMetricsSeriesSplit, FreightMetricsSeriesUnit, FreightMetricsSeriesPeriod
... freight_metrics_series_client = FreightMetricsSeries(config)
... freight_metrics_series_client.get(
...     metric=FreightMetricsSeriesMetric.TonMiles,
...     split=FreightMetricsSeriesSplit.VesselTypeCpp,
...     products=["gasoline", "DPP"],
...     unit=FreightMetricsSeriesUnit.KTNMI,
...     period=FreightMetricsSeriesPeriod.Monthly,
...     start_date=date(2020,1,1)
... )

Date	MR	GP	LR2	LR1	LR3	VLCC
2020-01-01	47167787.97	4805725.69	46909311.58	20111132.52	25888954.41	1212255.41
2020-02-01	44779639.94	4799508.63	48502313.55	19338796.56	18212888.97	1907541.54
2020-03-01	53292249.51	5701420.14	46698177.92	22726753.15	14412986.37	3788115.98
2020-04-01	41957007.33	5138045.73	48438084.70	20037436.18	11140717.43	2933625.42
2020-05-01	43838067.51	5344708.32	50284110.11	13431154.99	13004547.35	3421934.68
2020-06-01	42789911.76	4894000.27	41481731.47	13896678.66	13061101.23	3511137.65
2020-07-01	45617055.75	5043752.13	46691881.74	21080645.36	10519866.61	2661771.76
2020-08-01	44716307.74	4320194.82	48217646.71	16982323.71	9916214.49	5142621.42
2020-09-01	43714237.43	4754961.40	38954591.64	17309605.01	15690640.13	784688.29
2020-10-01	42514077.39	4729507.01	42225374.83	17845363.26	15703871.72	3513174.00
2020-11-01	15881015.99	1990767.03	17269526.99	5727516.67	8022010.01	1737537.15

get_columns()

This endpoint returns a recent and updated list of all columns available for the endpoint freight-metrics.

Examples

>>> from kpler.sdk.resources.freight_metrics_series import FreightMetricsSeries
... freight_metrics_series_client = FreightMetricsSeries(config)
... freight_metrics_series_client.get_columns()

id	name	description	deprecated	type
date	Date (timestamp)		False	string
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
vessel_type	Vessel Type	Type of the vessel	False	string
…	…	…	…	…

Return type

DataFrame

class kpler.sdk.FreightMetricsSeriesMetric(value)

AvgDistance = 'AvgDistance'

AvgSpeed = 'AvgSpeed'

TonDays = 'TonDays'

TonMiles = 'TonMiles'

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

Annually = 'annually'

Monthly = 'monthly'

Quarterly = 'quarterly'

class kpler.sdk.FreightMetricsSeriesSplit(value)

DestinationCountry = 'destinationCountry'

DestinationInstallation = 'destinationInstallation'

DestinationSourceEta = 'destinationSourceEta'

OriginCountry = 'originCountry'

OriginInstallation = 'originInstallation'

OriginSourceEta = 'originSourceEta'

Total = 'total'

VesselType = 'vesselType'

VesselTypeCpp = 'vesselTypeCpp'

VesselTypeOil = 'vesselTypeOil'

class kpler.sdk.FreightMetricsSeriesUnit(value)

KTDAY = 'kt/day'

KTNMI = 'kt/nmi'

MTNMI = 'mt/nmi'

TDAY = 't/day'

TNMI = 't/nmi'