Diversions

Note

available on platform : Platform.LNG

class kpler.sdk.resources.diversions.Diversions(configuration, column_ids=True, log_level=None)

The Diversions endpoint allows users to extract a list of historical & current diversions for all LNG vessels going back to 2019.

get(size=None, start_date=None, end_date=None, from_zones=None, to_zones=None, cancelled_zones=None, from_installations=None, to_installations=None, cancelled_installations=None, vessels=None, charterers=None, vessel_states=None, columns=None)

Parameters

• size – Optional[int] Maximum number of diversions returned

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

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

• from_zones – Optional[List[str]] Names of origin zones [“port”, “region”, “country”, “continent”]

• to_zones – Optional[List[str]] Names of destination zones

• cancelled_zones – Optional[List[str]] Names of diverted zones

• from_installations – Optional[List[str]] Names of origin installations

• to_installations – Optional[List[str]] Names of destination installations

• cancelled_installations – Optional[List[str]] Names of diverted installations

• vessels – Optional[List[str]] Names or IMOs of vessels

• charterers – Optional[List[str]] Names or charterers

• vessel_states – Optional[List[Enum]] = DiversionsVesselState

• columns – Optional[List[str]] Retrieve all available columns when set to “all”

Examples

>>> from kpler.sdk.resources.diversions import Diversions
... from kpler.sdk import DiversionsVesselState
... diversions_client = Diversions(config)
... diversions_client.get(
...     from_installations=["Sabine Pass"],
...     to_zones=["United States"],
...     size=10,
...     vessel_states=[DiversionsVesselState.Loaded]
... )

vessel_name	diversion_date	origin_diversion_location_name	origin_diversion_date	diverted_from_location_name	new_destination_location_name	new_destination_date	vessel_state	charterer_name
Hispania Spirit	2020-12-23 15:31:00	Sabine Pass	2020-12-17 08:57:00	Dragon	Rio	2021-01-11 11:27:00	Loaded	Shell
Gaslog Skagen	2020-11-30 00:00:00	Sabine Pass	2020-11-25 16:31:00	Dragon	Bahia	2020-12-06 16:01:00	Loaded	RWE
Maran Gas Ulysses	2020-03-05 00:00:00	Sabine Pass	2020-03-01 07:02:00	MED Sea	Quintero	2020-06-05 16:42:00	Loaded	Shell

get_columns()

This endpoint returns a recent and updated list of all columns available for the endpoint diversions.

Examples

>>> from kpler.sdk.resources.diversions import Diversions
... diversions_client = Diversions(config)
... diversions_client.get_columns()

id	name	description	deprecated	type
vessel_name	Vessel	None	False	string
diversion_date	Diversion date	None	False	datetime yyyy-MM-dd HH:mm
origin_diversion_location_name	Origin	None	False	string
origin_diversion_date	Origin Date	None	False	datetime yyyy-MM-dd HH:mm
diverted_from_location_name	Diverted from	None	False	string
new_destination_location_name	New Destination	None	False	string
new_destination_date	New Destination Date	None	False	datetime yyyy-MM-dd HH:mm
vessel_state	Vessel State	None	False	string
charterer_name	Charterer	None	False	string
…	…	…	…	…

Return type

DataFrame

class kpler.sdk.DiversionsVesselState(value)

Ballast = 'Ballast'

Loaded = 'Loaded'