Installations

Note

available on platforms : Platform.LNG

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

The Installations endpoint allows to perform full-text search on installations, in order to find names used in Kpler referential.

get(columns=None, continent=None, country=None, port=None, installation=None, continent_id=None, country_id=None, port_id=None, installation_id=None, type=None, owner=None)[source]
Parameters
  • continent – Optional[str] The installation’s continent name

  • country – Optional[str] The installation’s country name

  • port – Optional[str] The installation’s port name

  • installation – Optional[str] The installation’s name

  • continent_id – Optional[int] The installation’s continent ID in the Kpler system

  • country_id – Optional[int] The installation’s country ID in the Kpler system

  • port_id – Optional[int] The installation’s port ID in the Kpler system

  • installation_id – Optional[int] The installation’s ID in the Kpler system

  • type – Optional[str] The installation’s type, Import/Export

  • owner – Optional[str] The installation’s owner

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

Examples

>>> from kpler.sdk.resources.installations import Installations
... installations_client = Installations(config)
... installations_client.get(columns=["installation","installation_type", "status","lng_storage_capacity"])

installation

installation_type

status

lng_storage_capacity

Fos Tonkin

Import

Active

80000

Fos Cavaou

Import

Active

330000

Freeport (Reg.)

Import

Decommissioned

480000

Delfin FLNG

Export

Approved

Freeport

Export

Active

480000

Return type

DataFrame

get_columns()[source]

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

Examples

>>> from kpler.sdk.resources.installations import Installations
... installations_client = Installations(config)
... installations_client.get_columns()

id

name

description

deprecated

type

continent

Continent

The installation’s continent

False

string

subcontinent

Subcontinent

The installation’s subcontinent

False

string

country

Country

The installation’s country

False

string

port

Port

The installation’s port

False

string

installation

Installation

The Installation’s name

False

string

Return type

DataFrame

search(q)[source]
Parameters

q – str Argument to search by in installation names

Examples

>>> from kpler.sdk.resources.installations import Installations
... installations_client=Installations(config)
... installations_client.search("abidjan")

installations

SIR Abidjan

Abidjan Terminal

Return type

DataFrame