Refineries Refined Products Supply

Note

available on platforms : Platform.Liquids

class kpler.sdk.resources.refineries.refined_products_supply.RefinedProductsSupply(configuration, column_ids=True, log_level=None)

The RefinedProductsSupply endpoint returns the aggregated production of each refined product for a point of interest (installation/zone) on a daily, weekly, weekly EIA (for US), monthly and yearly basis.

get(players=None, installations=None, zones=None, start_date=None, end_date=None, products=None, unit=None, granularity=None, split=None)

Parameters

• players – Optional[str] Names of players

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

• zones – Optional[List[str]] Names of countries/geographical zones

• start_date – Optional[date] Start of the period (YYYY-MM-DD), must be after 2017-01-01

• end_date – Optional[date] End of the period (YYYY-MM-DD), maximum of 7 days from today

• products – Optional[List[Enum]] RefinedProducts

• unit – Optional[Enum] RefinedProductsUnit

• granularity – Optional[Enum] RefinedProductsGranularity

• split – Optional[Enum] RefinedProductsSplit

Examples

>>> from datetime import date
... from kpler.sdk.resources.refineries.refined_products_supply import RefinedProductsSupply
... from kpler.sdk import RefinedProducts, RefinedProductsUnit, RefinedProductsGranularity, RefinedProductsSplit
... refined_products_supply_client = RefinedProductsSupply(config)
... refined_products_supply_client.get(
...     installations=["xxxx"],
...     zones=["United States"],
...     start_date=date(2023, 4, 1),
...     end_date=date(2023, 7, 31),
...     player=["xxx"],
...     products=[RefinedProducts.All],
...     unit=RefinedProductsUnit.KBD,
...     granularity=RefinedProductsGranularity.Monthly,
...     split=RefinedProductsSplit.Total,
... )

Date	Zones	Installations	Split Value	Metric	Value	Unit
2023-04-01	United States		Total	Supply	79644.0	kbd
2023-05-01	United States		Total	Supply	79417.0	kbd
2023-06-01	United States		Total	Supply	79540.0	kbd
2023-07-01	United States		Total	Supply	81059.0	kbd

Return type

DataFrame

get_columns()

This endpoint returns a recent and updated list of all columns available for the endpoint refineries refined-products-supply.

Examples

>>> from kpler.sdk.resources.refineries.refined_products_supply import RefinedProductsSupply
... refined_products_supply_client = RefinedProductsSupply(config)
... refined_products_supply_client.get_columns()

id	name	description	deprecated	type
date	Date (timestamp)	Date, within the start_date and end_date. Data is provided with ascending order on date. Format YYYY-MM-DD.	False	string
zones	Zones	List of zones specified in the parameter zones.	False	list of string
installations	Installations	List of installations specified in the parameter installations.	False	list of string
splitValue	Split Value	Name of the bucket corresponding to the specified split. EG Americas or Asia for split by Continent.	False	string
metric	Metric	Corresponding to the endpoint.	False	string
…	…

Return type

DataFrame

class kpler.sdk.RefinedProductsGranularity(value)

Annually = 'year'

Daily = 'day'

EiaWeekly = 'eia-week'

Monthly = 'month'

Weekly = 'week'

class kpler.sdk.RefinedProductsUnit(value)

KB = 'kb'

KBD = 'kbd'

KT = 'kt'

M3 = 'm3'

MBBL = 'Mbbl'

MT = 'Mt'

PERCENTAGE = 'percentage'

class kpler.sdk.RefinedProducts(value)

All = 'All'

AsphaltBitumen = 'Asphalt/Bitumen'

BottomOfTheBarrel = 'Bottom of the Barrel'

Gasoline = 'Gasoline'

HighSulfurDiesel = 'High Sulfur Diesel'

HighSulfurFuelOil = 'High Sulfur Fuel Oil'

Jet = 'Jet'

LPG = 'LPG'

LowSulfurDiesel = 'Low Sulfur Diesel'

LowSulfurFuelOil = 'Low Sulfur Fuel Oil'

LubeOils = 'LubeOils'

MiddleOfTheBarrel = 'Middle of the Barrel'

Naphtha = 'Naphtha'

Olefins = 'Olefins'

Petcoke = 'Petcoke'

Slurry = 'Slurry'

TopOfTheBarrel = 'Top of the Barrel'

VGO = 'VGO'

class kpler.sdk.RefinedProductsSplit(value)

Continent = 'Continent'

Country = 'Country'

Product = 'Product'

Refinery = 'Refinery'

RefineryType = 'Refinery Type'

Subcontinent = 'Subcontinent'

Total = 'Total'

TradingRegion = 'Trading Region'