Trades Updates

Note

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

class kpler.sdk.resources.trades_updates.TradesUpdates(configuration, column_ids=False, log_level=None)[source]

The TradesUpdates query returns a updates of our trades data at a specified time.

get(products=None, start_date=None, show_all_history='false', columns=None, return_columns_ids=False)[source]

Parameters

products – Optional[List[str]] Names of products
start_date – Optional[datetime] The starting point in time of the returned “diffs”, in UTC 0 time. All diffs that have been computed strictly after that date will be returned. Note: a time window of 15 days of diffs are kept, you can’t look before in the past
show_all_history – Optional [String]: Use [‘true’, ‘false’]. Default to false if not specified.
columns – Optional[List[str]] Columns in the jsonUpdates field, Retrieve all available columns when set to “all”
return_columns_ids – Optional[bool] set it to True to use columns ids instead of names in the jsonUpdates column. Default to False if not specified.

Examples

>>> from datetime import date, timedelta, datetime
... from kpler.sdk.resources.trades_updates import TradesUpdates
... trades_updates_client = TradesUpdates(config)
... updates = trades_updates_client.get(
... products = ["crude"],
... start_date = datetime.strptime('2023-07-21T160000', '%Y-%m-%dT%H%M%S'),
... columns = [
...         "vessel_name",
...         "origin_location_name",
...         "destination_location_name",
...         "start",
...         "end"
... ]
... )
>>> print(updates.headers['lastAvailableDate'])
"2022-10-19T034600"

productId	tradeId	date	operation	jsonUpdates
1096	14686898	2022-09-21 14:01:00	UPDATE	{‘Date (destination)’:’2022-09-21 02:30’,’Dest…
1780	14870244	2022-09-21 14:01:00	UPDATE	{‘Date (destination)’:’2022-09-28 12:14’}
1248	15141376	2022-09-21 14:01:00	UPDATE	{‘Date (destination)’:’2022-09-21 10:00’,’Dest…
1280	15269441	2022-09-21 14:01:00	INSERT	{‘Vessel’:’San Matias I’,’Date (origin)’:’2022…
1932	15269510	2022-09-21 14:01:00	INSERT	{‘Vessel’:’Aretea’,’Date (origin)’:’2022-10-17…
…	…	…	…	…

Return type: DataFrame