Ballast Capacity Port Calls

Note

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

class kpler.sdk.resources.ballast_capacity_port_calls.BallastCapacityPortCalls(configuration, column_ids=True, log_level=None)[source]

The BallastCapacityPortCalls endpoint provides all the list of ballast vessels on the input period with their next load ETA and Destination.

get(start_date=None, end_date=None, zones=None, products=None, vessel_types_cpp=None, vessel_types_oil=None, sources=None, vessel_state=None, size=None, vessel_types=None, gte=None, lte=None, with_freight_view=False)[source]
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]] VesselTypesCPP

  • vessel_types_oil – Optional[List[Enum]] VesselTypesOil

  • sources – Optional[List[Enum]] BallastCapacityPortCallsSources

  • vessel_state – Optional[List[Enum]] BallastCapacityPortCallsVesselStates

  • size – Optional[int] Maximum number of ballast capacity port calls returned

  • 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_port_calls import BallastCapacityPortCalls
... ballast_capacity_port_calls_client = BallastCapacityPortCalls(config)
... ballast_capacity_port_calls_client.get(
...         zones=["Japan"],
...         products=["crude/co"]
... )

Date (timestamp)

IMO

Name

Dead Weight Tonnage

Cargo (t)

Next Installation

Next Port

Next Country

Next zone

Next ETA

2020-11-24

9868132

Bei Hai Qi Lin

69900.0

75891.0

Kiire

Kiire

Japan

Asia

2020-12-18

2020-11-24

9868132

Bei Hai Qi Lin

69900.0

75891.0

Kiire

Kiire

Japan

Asia

2020-12-08

2020-11-24

9868132

Bei Hai Qi Lin

69900.0

75891.0

Kiire

Kiire

Japan

Asia

2020-11-28

get_columns()[source]

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

Examples

>>> from kpler.sdk.resources.ballast_capacity_port_calls import BallastCapacityPortCalls
... ballast_capacity_port_calls_client = BallastCapacityPortCalls(config)
... ballast_capacity_port_calls_client.get_columns()

id

name

description

deprecated

type

date

Date (timestamp)

Date (timestamp)

False

date yyyy-MM-dd

vessel_imo

IMO

Vessel IMO

False

long

vessel

Name

Vessel name

False

string

vessel_dwt_tons

Capacity

Dead Weight Tonnage

False

long

cargo_tons

Cargo (t)

Cargo (t)

False

double

Return type

DataFrame

class kpler.sdk.VesselTypesCPP(value)[source]
GP = 'GP'
LR1 = 'LR1'
LR2 = 'LR2'
LR3 = 'LR3'
MR = 'MR'
VLCC = 'VLCC'
class kpler.sdk.VesselTypesOil(value)[source]
Aframax = 'Aframax'
Panamax = 'Panamax'
ProductTanker = 'Product Tanker'
Suezmax = 'Suezmax'
ULCC = 'ULCC'
VLCC = 'VLCC'
class kpler.sdk.VesselTypesLNG(value)[source]
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)[source]
Handysize = 'Handysize'
LGC = 'LGC'
MGC = 'MGC'
SGC = 'SGC'
VLEC = 'VLEC'
VLGC = 'VLGC'
class kpler.sdk.VesselTypesDry(value)[source]
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.BallastCapacityPortCallsSources(value)[source]
AIS = 'AIS'
Analyst = 'Analyst'
Fixture = 'Fixture'
Forecast = 'Forecast'
Market = 'Market'
Port = 'Port'
class kpler.sdk.BallastCapacityPortCallsVesselStates(value)[source]
Ballast = 'Ballast'
Loaded = 'Loaded'