Inventories

Note

available on platform : Platform.Liquids

class kpler.sdk.resources.inventories.Inventories(configuration, column_ids=True, log_level=None)[source]

The Inventories endpoint returns inland crude oil stocks of a given point of interest, with a specific periodicity over a period of time. Waterborne Cargoes, local Supply and Demand will also be returned for the given point of interest.

get(size=None, start_date=None, end_date=None, installations=None, zones=None, period=None, split=None, columns=None, cargo_tracking_enhancement=None, add_commodities_on_water=None, floating_storage_duration_min=None, floating_storage_duration_max=None, without_eia_adjustment=None)[source]
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)

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

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

  • period – Optional[Enum] InventoriesPeriod

  • split – Optional[Enum] InventoriesSplit

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

  • cargo_tracking_enhancement – Optional[bool] Use cargo tracking data to fill the blanks in between satellite images (default: False)

  • add_commodities_on_water – Optional[bool] Provides total volume of inventories including offshore and offshore. Default to false if not specified.

  • floating_storage_duration_min – Optional[str] Minimum floating days [7-10-12-15-20-30-90]

  • floating_storage_duration_max – Optional[str] Maximum floating days [10-12-15-20-30-90-Inf]

  • without_eia_adjustment – Optional[bool] No use of EIA data for enhancing inventories volumes (default: False)

Examples

>>> from datetime import date
... from kpler.sdk.resources.inventories import Inventories
... from kpler.sdk import InventoriesSplit
... inventories_client = Inventories(config)
... inventories_client.get(
...     start_date=date(2020,10,1),
...     end_date=date(2020,11,1),
...     zones=["Japan"],
...     split=InventoriesSplit.Total
... )

Date

Zone

Installation

Level (kb)

Local Supply (kbd)

Local Demand (kbd)

Cargoes (kbd)

Capacity (kb)

2020-10-01 23:59:00

Japan

NaN

354342

0

2377

2594

474008”,

2020-10-02 23:59:00

Japan

NaN

354492

0

2090

2705

474008

2020-10-03 23:59:00

Japan

NaN

354178

0

2087

1101

474008

2020-10-04 23:59:00

Japan

NaN

354073

0

1883

2500

474008

2020-10-05 23:59:00

Japan

NaN

354187

0

1862

916

474008

class kpler.sdk.InventoriesPeriod(value)[source]
Annually = 'annually'
Daily = 'daily'
EiaWeekly = 'eia-weekly'
Monthly = 'monthly'
Weekly = 'weekly'
class kpler.sdk.InventoriesSplit(value)[source]
ByCountry = 'byCountry'
ByInstallation = 'byInstallation'
ByOnshoreOffshoreStatus = 'byOnshoreOffshoreStatus'
ByPlayer = 'byPlayer'
ByTankType = 'byTankType'
Total = 'total'