Refineries Overview

Note

available on platforms : Platform.Liquids

class kpler.sdk.resources.refineries.overview.Overview(configuration, column_ids=True, log_level=None)

The Overview endpoint returns a list of refineries along with their respective characteristics for a point of interest (installation/zone).

get(players=None, installations=None, zones=None, start_date=None, end_date=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

Examples

>>> from datetime import date
... from kpler.sdk.resources.refineries.overview import Overview
... overview_client = Overview(config)
... overview_client.get(
...     installations=["xxxx"],
...     zones=["United States"],
...     start_date=date(2023, 4, 1),
...     end_date=date(2023, 7, 31),
...     player=["xxx"],
... )

Start Date	End Date	Zones	Installations	Refinery	Owner	Age (years)	NCI	Type	…
2023-04-01	2023-07-01	Tacoma	Targa Tacoma	Seaport Sound Refinery	Targa Resources	46	None	Other	…
2023-04-01	2023-07-01	Lovington	Lovington Refinery	Lovington Refinery	HollyFrontier	2	10.3	Complex	…
2023-04-01	2023-07-01	Indianapolis	Indianapolis Refinery	Indianapolis Refinery	Marathon Oil Corporation	63	None	Other	…

Return type

DataFrame

get_columns()

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

Examples

>>> from kpler.sdk.resources.refineries.overview import Overview
... overview_client = Overview(config)
... overview_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
refinery	Refinery	Name of the refinery	False	string
owner	Owner	Name of the owner	False	string
…	…	…	…	…	…	…	…	…

Return type

DataFrame