Refineries Margins

Note

available on platforms : Platform.Liquids

class kpler.sdk.resources.refineries.margins.Margins(configuration, column_ids=True, log_level=None)[source]

The Margins endpoint returns the margins 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, granularity=None, split=None)[source]
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

  • granularity – Optional[Enum] MarginsGranularity

  • split – Optional[Enum] MarginsSplit

Examples

>>> from datetime import date
... from kpler.sdk.resources.refineries.margins import Margins
... from kpler.sdk import MarginsGranularity, MarginsSplit
... margins_client = Margins(config)
... margins_client.get(
...     installations=["xxxx"],
...     zones=["United States"],
...     start_date=date(2023, 4, 1),
...     end_date=date(2023, 7, 31),
...     player=["xxx"],
...     granularity=MarginsGranularity.Monthly,
...     split=MarginsSplit.Total,
... )

Date

Zones

Installations

Split Value

Value

Unit

2023-04-01

United States

Total

12.0

$/bbl

2023-05-01

United States

Total

13.5

$/bbl

2023-06-01

United States

Total

21.0

$/bbl

2023-07-01

United States

Total

23.4

$/bbl

Return type

DataFrame

get_columns()[source]

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

Examples

>>> from kpler.sdk.resources.refineries.margins import Margins
... margins_client = Margins(config)
... margins_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

Return type

DataFrame

class kpler.sdk.MarginsGranularity(value)[source]
Annually = 'year'
Daily = 'day'
EiaWeekly = 'eia-week'
Monthly = 'month'
Weekly = 'week'
class kpler.sdk.MarginsSplit(value)[source]
Continent = 'Continent'
Country = 'Country'
Refinery = 'Refinery'
RefineryType = 'Refinery Type'
Subcontinent = 'Subcontinent'
Total = 'Total'
TradingRegion = 'Trading Region'