Flows

Note

available on platforms : Platform.Liquids, Platform.LNG, Platform.LPG, Platform.Dry

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

The Flows endpoint returns the aggregated flows for a point of interest (installation/zone) on a daily, weekly, weekly EIA (for US), monthly and yearly basis.

get(flow_direction=None, split=None, granularity=None, start_date=None, end_date=None, from_installations=None, to_installations=None, from_zones=None, to_zones=None, products=None, only_realized=None, unit=None, with_intra_country=None, with_forecast=None, with_freight_view=False, vessel_types=None, vessel_types_alt=None)[source]
Parameters
  • flow_direction – Optional[List[Enum]] FlowsDirection

  • split – Optional[List[Enum]] FlowsSplit

  • granularity – Optional[List[Enum]] FlowsPeriod

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

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

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

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

  • from_zones – Optional[List[str]] Names of zones [“port”, “region”, “country”, “continent”]

  • to_zones – Optional[List[str]] = Names of zones [“port”, “region”, “country”, “continent”]

  • products – Optional[List[str]] = Names of products

  • only_realized – Optional[bool] By default: onlyRealized=false. Takes into account only the trades that have been finished. Use [“true”, “false”]

  • unit – Optional[List[Enum]] FlowsMeasurementUnit

  • with_intra_country – Optional[bool] By default: withIntraCountry=false. Takes into account the trades within the selected region. Use [“true”, “false”]

  • with_forecast – Optional[bool] By default: withForecast=true. Include trades predicted by our in-house model when set to “true”. Use [“true”, “false”]

  • with_freight_view

    bool By default: with_freight_view=False. Provides access to the entire fleet’s trades, irrespective of your current cargo subscription. Only available via Freight subscription.

    vessel_types: Optional[List[str]] = Names of vessel types vessel_types_alt: Optional[List[str]] = Names of vessel types for oil liquids platform only

Examples

>>> from datetime import date
... from kpler.sdk.resources.flows import Flows
... from kpler.sdk import FlowsDirection, FlowsSplit, FlowsPeriod, FlowsMeasurementUnit
... flows_client = Flows(config)
... flows_client.get(
...     flow_direction=[FlowsDirection.Export],
...     split=[FlowsSplit.OriginCountries],
...     granularity=[FlowsPeriod.Daily],
...     unit=[FlowsMeasurementUnit.T],
...     start_date=date(2020,9,1),
...     end_date=date(2020,10,1)
... )

Belgium

Singapore Republic

Equatorial Guinea

Trinidad and Tobago

Peru

Qatar

Netherlands

Cameroon

France

2020-09-01

0.00

0.00

0.00

31503.98

0.00

444830.12

0.0

0.00

0.00

2020-09-02

0.00

0.00

0.00

29470.38

0.00

127286.51

0.0

0.00

0.00

2020-09-03

0.00

0.00

0.00

0.00

0.00

217991.87

0.0

0.00

0.00

2020-09-04

0.00

0.00

0.00

0.00

0.00

279156.75

0.0

0.00

75441.15

2020-09-05

0.00

450.00

0.00

55242.96

77166.98

96567.48

3038.4

0.00

0.00

2020-09-06

0.00

0.00

0.00

66487.50

0.00

281436.69

71762.4

34352.10

0.00

class kpler.sdk.FlowsDirection(value)[source]
Export = 'export'
Import = 'import'
NetExport = 'netexport'
NetImport = 'netimport'
class kpler.sdk.FlowsSplit(value)[source]
Buyers = 'buyer'
Charterers = 'charterers'
CrudeQuality = 'crude quality'
DestinationContinents = 'destination continents'
DestinationCountries = 'destination countries'
DestinationInstallations = 'destination installations'
DestinationPadds = 'destination padds'
DestinationSubcontinents = 'destination subcontinents'
DestinationTradingRegions = 'destination trading regions'
Grades = 'grades'
OriginContinents = 'origin continents'
OriginCountries = 'origin countries'
OriginInstallations = 'origin installations'
OriginPadds = 'origin padds'
OriginSubcontinents = 'origin subcontinents'
OriginTradingRegions = 'origin trading regions'
Products = 'products'
Routes = 'routes'
Sellers = 'seller'
Sources = 'sources'
Total = 'total'
TradeStatus = 'trade status'
VesselType = 'vessel type'
VesselTypeCpp = 'vessel type cpp'
VesselTypeOil = 'vessel type oil'
class kpler.sdk.FlowsPeriod(value)[source]
Annually = 'annually'
Daily = 'daily'
EiaWeekly = 'eia-weekly'
Monthly = 'monthly'
Weekly = 'weekly'
class kpler.sdk.FlowsMeasurementUnit(value)[source]
BBL = 'bbl'
CM = 'cm'
KB = 'kb'
KBD = 'kbd'
KT = 'kt'
MMBBL = 'mmbbl'
MT = 'mt'
T = 't'