Prices

Note

available on platform : Platform.LNG

class kpler.sdk.resources.prices.Prices(configuration, column_ids=True, log_level=None)

The Prices endpoint allows you to extract the latest prices information in $/MMBtu for various indexes and prices benchmarks, including Henry Hub, TTF, NBP, SLInG (Singapore, N.Asia, DKI), RIM, 11.5% Brent, and 14.5% JCC.

get(size=None, start_date=None, end_date=None, indexes=None, columns=None)

Parameters

• size – Optional[int] Maximum number of prices returned

• start_date – Optional[date] Start of the period (YYYY-MM-DD)

• end_date – Optional[date] End of the period (YYYY-MM-DD)

• indexes – Optional[List[Enum]] PricesIndexes

• columns – Optional[List[str]] Retrieve all available columns when set to “all”

Examples

>>> from datetime import date
... from kpler.sdk.resources.prices import Prices
... from kpler.sdk import PricesIndexes
... prices_client = Prices(config)
... prices_client.get(
...     start_date=date(2020,9,1),
...     end_date=date(2020,10,1),
...     size=10,
...     indexes=[PricesIndexes.HenryHub, PricesIndexes.TTF]
... )

id	index	ticker	reference month	date	price
88530	TTF	TTFN1	2020-11-01 00:00	2020-10-01	4.522
88531	TTF	TTFN2	2020-12-01 00:00	2020-10-01	4.650
88532	TTF	TTFN3	2021-01-01 00:00	2020-10-01	4.711
88533	TTF	TTFN4	2021-02-01 00:00	2020-10-01	4.721
88534	TTF	TTFN5	2021-03-01 00:00	2020-10-01	4.652
88466	Henry Hub	HenryHubN1	2020-10-01 00:00	2020-10-01	2.100
88467	Henry Hub	HenryHubN2	2020-11-01 00:00	2020-10-01	2.564
88468	Henry Hub	HenryHubN3	2020-12-01 00:00	2020-10-01	3.126
88469	Henry Hub	HenryHubN4	2021-01-01 00:00	2020-10-01	3.275
88470	Henry Hub	HenryHubN5	2021-02-01 00:00	2020-10-01	3.223

get_columns()

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

Examples

>>> from kpler.sdk.resources.prices import Prices
... prices_client = Prices(config)
... prices_client.get_columns()

id	name	description	deprecated	type
id	Id	Identifier in the database of Kpler	False	long
index	Index	Name of Index referenced	False	string
ticker	Ticker	None	False	string
reference month	Reference Month	None	False	datetime yyyy-MM-dd HH:mm
date	Date	None	False	datetime yyyy-MM-dd HH:mm
price	Price	None	False	double

Return type

DataFrame

class kpler.sdk.PricesIndexes(value)

Brent = 'Brent'

DKISling = 'DKI Sling'

HenryHub = 'Henry Hub'

JCC = 'JCC'

JLC = 'JLC'

NBP = 'NBP'

NorthAsiaSling = 'North Asia Sling'

RIMNEAsia = 'RIM NE Asia'

SingaporeSling = 'Singapore Sling'

TTF = 'TTF'