Contracts

Note

available on platform : Platform.LNG

class kpler.sdk.resources.contracts.Contracts(configuration, column_ids=True, log_level=None)

The Contracts endpoint allows you to extract a list of SPAs, TUAs, LTAs, and Tenders for all LNG players, installations and zones.

get(columns=None, size=None, start_date=None, end_date=None, players=None, types=None, installations=None, zones=None)

This endpoint returns a list of contracts for the given arguments.

Parameters

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

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

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

• players – Optional[str] Represents the buyers/sellers on the contracts

• types – Optional[List[Enum]] ContractsTypes

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

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

Examples

>>> from datetime import date
... from kpler.sdk.resources.contracts import Contracts
... from kpler.sdk import ContractsTypes
... contracts_client = Contracts(config)
... contracts_client.get(
...     size=10,
...     start_date=date(2018,1,1),
...     end_date=date(2020,10,1),
...     installations=["Dahej"],
...     zones=["India"],
...     players=["Shell"],
...     types=[ContractsTypes.Tender]
... )

type	seller	buyer	capacity	slots	delivery	start	end	installations origin	installations destination	origin zone	…
Tender	Shell	IOC	NaN	1	DES	2019-08-15 00:00	2019-08-31 00:00	NaN	Dahej, Ennore LNG	World
Tender	Shell	BPCL	NaN	1	DES	2018-08-20 00:00	2018-09-15 00:00	NaN	Dahej, Hazira	World
Tender	Shell	IOC	NaN	1	DES	2018-05-01 00:00	2018-05-31 00:00	NaN	Dahej	World
Tender	Shell	BPCL	NaN	1	DES	2018-05-01 00:00	2018-05-31 00:00	NaN	Dahej	World
Tender	Shell	GAIL	NaN	2	DES	2018-04-10 00:00	2018-05-05 00:00	NaN	Dahej, Dabhol	World
Tender	Shell	GAIL	NaN	1	DES	2018-02-15 00:00	2018-02-28 00:00	NaN	Dahej	World
Tender	Shell	BPCL	NaN	1	DES	2018-01-19 00:00	2018-01-23 00:00	NaN	Dahej	World

get_columns()

Examples

>>> from kpler.sdk.resources.contracts import Contracts
... contracts_client = Contracts(config)
... contracts_client.get_columns()

id	name	description	deprecated	type
type	Type	Type of contracts (SPA, LTA, TUA, Tender)	False	string
seller	Seller	Company name of the seller	False	string
buyer	Buyer	Company name of the buyer	False	string
capacity	Capacity	None	False	float
slots	Slots	None	False	integer
…	…	…	…	…

Return type

DataFrame

class kpler.sdk.ContractsTypes(value)

LTA = 'LTA'

SPA = 'SPA'

TUA = 'TUA'

Tender = 'Tender'