Port Calls

Note

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

class kpler.sdk.resources.port_calls.PortCalls(configuration, column_ids=True, log_level=None)

The PortCalls query returns the cargo-by-cargo details for loadings/discharges taking place in a point of interest (installation/zone).

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

Parameters

• size – Optional[int] Maximum number of portcalls

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

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

• zones – Optional[List[str]] Names of zones [“port”, “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)

• with_forecast – Optional[bool] By default: withForecast=true. Include trades predicted by our in-house model when set to “true”. Use [“true”, “false”]

• 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.port_calls import PortCalls
... port_calls_client = PortCalls(config)
... port_calls_client.get(
...     start_date=date.today() - timedelta(days=7),
...     zones=["United States"],
...     installations=["Everglades"],
...     columns=["vessel_name","installation_name","eta","start","end","flow_quantity_cubic_meters"]
... )

vessel_name	installation_name	eta	start	end	flow_quantity_cubic_meters
Palmetto State	Everglade	2020-12-11 21:00:00	NaT	NaT	-29681.0
Golden State	Everglade	2020-12-10 17:00:00	NaT	NaT	-53477.0
Overseas Houston	Everglade	2020-12-09 11:00:00	NaT	NaT	-51560.0
Garden State	Everglade	2020-12-09 02:00:00	NaT	NaT	-54045.0
American Liberty	Everglade	2020-12-08 22:00:00	NaT	NaT	-54736.0
Louisiana	Everglade	2020-12-06 16:00:00	2020-12-06 18:01:00	2020-12-07 03:05:00	-9445.0
California Voyager	Everglade	2020-12-04 03:00:00	2020-12-04 03:28:00	2020-12-05 11:51:00	-37295.0
Brenton Reef	Everglade	2020-12-02 20:30:00	2020-12-02 21:56:00	2020-12-04 02:00:00	-50339.0
…	…	…	…	…	…

Return type

DataFrame

get_columns()

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

Examples

>>> from kpler.sdk.resources.port_calls import PortCalls
... port_calls_client = PortCalls(config)
... port_calls_client.get_columns()

id	name	description	deprecated	type
vessel_name	Vessel	Name of the vessel	False	string
installation_name	Installation	Name of the installation	False	string
eta	ETA	Estimated date and time of arrival at next destination	False	datetime yyyy-MM-dd HH:mm
start	Start	Date and Time when the vessel started berthing at the terminal	False	datetime yyyy-MM-dd HH:mm
end	End	Date and Time of vessel departure from the terminal	False	datetime yyyy-MM-dd HH:mm
…	…	…	…	…

Return type

DataFrame