Vessels

Note

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

class kpler.sdk.resources.vessels.Vessels(configuration, column_ids=True, log_level=None)

The Vessels query returns a snapshot of the current status of the fleet, including details on vessels status, last port call and next destination.

get(columns=None, with_freight_view=False)

Parameters

• 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.vessels import Vessels
... vessels_client = Vessels(config)
... vessels_client.get(columns=["vessel_name","vessel_status","last_port_call_end"])

vessel_name	vessel_status	last_port_call_location_name	next_destination_zone_name
…	…	…	…
Anichkov Bridge	Active	Pelepas Light.	Western Petroleum B Anchorage
Anika	Active	PT SON Edible Oil Refinery	Lahad Datu
Anikitos	Inactive
Anikitos	Inactive
Anikitos	Active	Rio Grande	Barcarena
…	…	…	…

Return type

DataFrame

get_columns()

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

Examples

>>> from kpler.sdk.resources.vessels import Vessels
... vessels_client = Vessels(config)
... vessels_client.get_columns()

id	name	description	deprecated	type
vessel_name	Vessels	Name of the vessels	False	string
vessel_status	Status	Status of the vessels	False	string
last_port_call_location_name	Last port-call	Vessels’s last port call location	False	string
last_port_call_end	Departure date	End of the last port call	False	datetime yyyy-MM-dd HH:mm
cargo_on_board_cubic_meters	Volume	None	False	double
…	…	…	…	…

Return type

DataFrame

search(q)

Performs the vessels name search by the given arguments

Parameters

q – str Argument to search by in vessels names

Examples

>>> from kpler.sdk.resources.vessels import Vessels
... vessels_client = Vessels(config)
... vessels_client.search("Ab")

vessels
Abu Dhabi-Iii
Bolan
D&K Abdul Razzak Khalid Zaid Al-Khalid
Abalone
Abdias Nascimento
…

Return type

DataFrame