Tonnage Supply Series
Note
available on platforms : Platform.Liquids, Platform.LNG, Platform.LPG, Platform.Dry
- class kpler.sdk.resources.tonnage_supply_series.TonnageSupplySeries(configuration, column_ids=True, log_level=None)[source]
The
TonnageSupplySeriesendpoint returns lists of vessels which can arrive at a queried destination zone within a specified timeframe assuming a specified speed.- get(destination, eta, speed, metric, start_date=None, end_date=None, split=None, products=None, vessel_states=None, vessel_types=None, gte=None, lte=None, match_next_port_call=None, build_year=None, build_year_min=None, build_year_max=None, is_open=None)[source]
- Parameters
destination – str Destination name (zone)
eta – int ETA in days
speed – int Speed in knots
metric – Enum
TonnageSupplySeriesMetricstart_date – Optional[date] Start of the period (YYYY-MM-DD)
end_date – Optional[date] End of the period (YYYY-MM-DD)
split – Optional[Enum]
TonnageSupplySeriesSplitproducts – Optional[List[str]] Names of products/grades eg: crude/co, gasoil
vessel_states – Optional[List[Enum]]
TonnageSupplyVesselsStatevessel_types – Optional[List[Enum]]
TonnageSupplyVesselTypesgte – 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
match_next_port_call – Optional[bool] Filter to vessels for which the zone of the next port call matches the destination
build_year – Optional[int] Filter for vessels built in a specific year (exact match). Cannot be used together with build_year_min or build_year_max
build_year_min – Optional[int] Filter for vessels built from this year onwards (inclusive). Use with build_year_max to define a range
build_year_max – Optional[int] Filter for vessels built up to this year (inclusive). Use with build_year_min to define a range
is_open – Optional[bool] Filter to vessels marked as open
Examples
>>> from datetime import date ... from kpler.sdk.resources.tonnage_supply_series import TonnageSupplySeries ... from kpler.sdk import TonnageSupplySeriesMetric, TonnageSupplySeriesSplit, TonnageSupplyVesselTypes ... tonnage_supply_series_client = TonnageSupplySeries(config) ... tonnage_supply_series_client.get( ... destination="Houston", ... eta=7, ... speed=11, ... start_date=date(2025,10,1), ... end_date=date(2025,11,1), ... metric=TonnageSupplySeriesMetric.Count, ... split=TonnageSupplySeriesSplit.VesselType, ... vessel_types=[TonnageSupplyVesselTypes.VLCC], ... build_year_min=2010 ... )
Date
VLCC
2025-10-01
17
2025-10-02
15
2025-10-03
18
2025-10-04
18
2025-10-05
19
2025-10-06
19
2025-10-07
19
2025-10-08
21
2025-10-09
20
2025-10-10
20
2025-10-11
20
2025-10-12
20
2025-10-13
19
2025-10-14
20
2025-10-15
20
2025-10-16
19
2025-10-17
21
2025-10-18
18
2025-10-19
17
2025-10-20
18
2025-10-21
15
2025-10-22
15
2025-10-23
17
2025-10-24
17
2025-10-25
19
2025-10-26
17
2025-10-27
16
2025-10-28
17
2025-10-29
18
2025-10-30
14
2025-10-31
15
2025-11-01
18
- class kpler.sdk.TonnageSupplySeriesMetric(value)[source]
Metrics for Tonnage Supply Series endpoint
- Capacity = 'capacity'
- Count = 'count'
- DeadWeight = 'deadWeight'
- class kpler.sdk.TonnageSupplySeriesSplit(value)[source]
Split options for Tonnage Supply Series endpoint
- CurrentContinents = 'currentContinents'
- CurrentCountries = 'currentCountries'
- CurrentSeas = 'currentSeas'
- CurrentSubcontinents = 'currentSubcontinents'
- CurrentSubregions = 'currentSubregions'
- Direction = 'direction'
- NextContinents = 'nextContinents'
- NextCountries = 'nextCountries'
- NextPorts = 'nextPorts'
- NextSubContinents = 'nextSubContinents'
- NextTradingRegions = 'nextTradingRegions'
- PreviousContinents = 'previousContinents'
- PreviousCountries = 'previousCountries'
- PreviousPorts = 'previousPorts'
- PreviousSubContinents = 'previousSubContinents'
- PreviousTradingRegions = 'previousTradingRegions'
- Product = 'product'
- State = 'state'
- SubState = 'subState'
- Total = 'total'
- VesselType = 'vesselType'
- class kpler.sdk.TonnageSupplyVesselTypes(value)[source]
Vessel types for Tonnage Supply endpoints (cross-platform)
- AframaxLR2 = 'Aframax/LR2'
- BabyCapes = 'Baby Capes'
- Capesize = 'Capesize'
- Handy = 'Handy'
- HandyMR1 = 'Handy/MR1'
- Handymax = 'Handymax'
- Handysize = 'Handysize'
- IntermediateTankers = 'Intermediate Tankers'
- Kamsarmax = 'Kamsarmax'
- LGC = 'LGC'
- LargeScaleFloater = 'Large-Scale Floater'
- LowerConventional = 'Lower Conventional'
- MGC = 'MGC'
- MR = 'MR'
- MidConventional = 'Mid Conventional'
- MidScale = 'Mid-Scale'
- MiniBulker = 'Mini Bulker'
- Newcastlemax = 'Newcastlemax'
- Panamax = 'Panamax'
- PanamaxLR1 = 'Panamax/LR1'
- PostPanamax = 'Post-Panamax'
- QFlex = 'Q-Flex'
- QMax = 'Q-Max'
- SGC = 'SGC'
- ShortSeaTankers = 'Short Sea Tankers'
- SmallScale = 'Small-Scale'
- SmallTankers = 'Small Tankers'
- SuezmaxLR3 = 'Suezmax/LR3'
- Supramax = 'Supramax'
- Ultramax = 'Ultramax'
- UpperConventional = 'Upper Conventional'
- VLAC = 'VLAC'
- VLCC = 'VLCC'
- VLEC = 'VLEC'
- VLGC = 'VLGC'
- VLOC = 'VLOC'
- Valemax = 'Valemax'