Ship To Ships

Note

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

class kpler.sdk.resources.ship_to_ships.ShipToShips(configuration, column_ids=True, log_level=None)

The ShipToShips endpoint returns the ship-to-ships loadings/discharges in a given zone,with details on the vessels taking part in the operation and crude grades being exchanged for a given time period.

get(size=None, vessels=None, zones=None, products=None, start_date=None, end_date=None, columns=None, with_freight_view=False)

Parameters

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

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

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

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

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

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

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

• 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.ship_to_ships import ShipToShips
... ship_to_ships_client = ShipToShips(config)
... ship_to_ships_client.get(
...     zones=["Zeebrugge"],
...     columns=["load_vessel_name","load_vessel_imo","discharge_vessel_name","discharge_vessel_imo","flow_quantity_cms","zone_name","start","end"]
... )

load_vessel_name	load_vessel_imo	discharge_vessel_name	discharge_vessel_imo	zone_name	start	end
Red Opal	9381512	Team Falcon	9396012	Zeebrugge	2017-06-02 18:06:00	2017-06-02 18:06:00
Adebomi 3	9210907	Dong-A Maia	9749544	Zeebrugge	2017-04-26 01:02:00	2017-04-26 05:05:00
Lafayette Bay	9717785	Sloman Themis	9306677	Zeebrugge	2017-02-24 02:00:00	2017-02-24 04:00:00
Talara	9569994	Lafayette Bay	9717785	Zeebrugge	2017-02-23 22:31:00	2017-02-23 23:00:00
Hafnia Hope	9360415	Nave Bellatrix	9459084	Zeebrugge	2017-01-12 22:01:00	2017-01-12 23:01:00
…	…	…	…	…	…	…	…

get_columns()

This endpoint returns a recent and updated list of all columns available for the endpoint ship-to-ships.

Examples

>>> from kpler.sdk.resources.ship_to_ships import ShipToShips
... ship_to_ships_client = ShipToShips(config)
... ship_to_ships_client.get_columns()

id	name	description	deprecated	type
load_vessel_name	Vessel (load)	Name of the vessel load	False	string
load_vessel_imo	IMO (load)	IMO of the vessel load	False	string
discharge_vessel_name	Vessel (discharge)	Name of the vessel discharge	False	string
discharge_vessel_imo	IMO (discharge)	IMO of the vessel discharge	False	string
flow_quantity_cms	Volume (cm)	None	False	long
…	…	…	…	…

Return type

DataFrame