derivitec.core.client.DerivitecClient.get_commodities

DerivitecClient.get_commodities(commodity_ids, descriptors, market_dates, provider_id=None, market_data_environment_name=None)[source]

Get commodities

Parameters:

  • commodity_ids (list of CommodityId) – The commodity ids.

  • descriptors (dict) – The descriptors.

  • market_dates (list of datetime.datetime) – The market dates.

  • provider_id (str) – The provider ID (optional)

  • market_data_environment_name (str) – The market data environment name (optional with default Organisation Level Environment)

Return type:

list of Commodity

Code

Get the Aluminium commodity from LME exchange.

>>> commodity_id = CommodityId(Name="Aluminium", Exchange="LME")
>>> commodity_ids = [commodity_id]
>>> descriptors = { commodity_id : CommodityDescriptor() }
>>> market_date = datetime(2017, 8, 14)
>>> market_dates = [market_date]
>>> market_data_environment_name = "Example Market Data Environment"
>>> client.get_commodities(commodity_ids, descriptors, market_dates, market_data_environment_name)