Fixtures

Note

available on platforms : Platform.Liquids

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

The Fixtures query returns the Fixtures data.

get(size=None, reported_date_after=None, reported_date_before=None, lay_can_start_after=None, lay_can_start_before=None, from_zones=None, to_zones=None, products=None, dwt_min=None, dwt_max=None, capacity_min=None, capacity_max=None, statuses=None, vessel_types_cpp=None, vessel_types_oil=None, vessel_types=None, vessels=None, columns=None)[source]
Parameters
  • size – Optional[int] By default: size=1000 Maximum number of results returned.

  • reported_date_after – Optional[date] Get fixtures reported on or after this date (YYYY-MM-DD)

  • reported_date_before – Optional[date] Get fixtures reported on or before this date (YYYY-MM-DD)

  • lay_can_start_after – Optional[date] Get fixtures with loading window start date after this date (YYYY-MM-DD)

  • lay_can_start_before – Optional[date] Get fixtures with loading window start date before this date (YYYY-MM-DD)

  • from_zones – Optional[List[str]] Names of the origin zones (port/region/country/continent)

  • to_zones – Optional[List[str]] Names of the destination zones (port/region/country/continent)

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

  • dwt_min – Optional[int] Get vessels with deadweight greater or equal to this value by default 0

  • dwt_max – Optional[int] Get vessels with deadweight lower or equal to this value by default 606550

  • capacity_min – Optional[int] Get vessels with capacity greater or equal to this value by default 0

  • capacity_max – Optional[int] Get vessels with capacity lower or equal to this value by default 606550

  • statuses – Optional[List[Enum]] `FixturesStatuses` Status of the fixture (On Subs/In Progress/Fully Fixed/Finished/Failed/Cancelled)

  • vessel_types_cpp – Optional[List[Enum]] `VesselTypesCpp` For given cpp vessel types (LR2, VLCC, LR3, MR, GP, LR1), only available for Liquids

  • vessel_types_oil – Optional[List[Enum]] `VesselTypesOil` For given oil vessel types (Aframax, VLCC, Product Tanker, Suezmax, Panamax, ULCC), only available for Liquids

  • vessel_types – Optional[List[str]] For other vessel types

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

  • vessels – Optional[List[str]] Names/IMO’s of vessels

Examples

>>> from datetime import date, timedelta, datetime
... from kpler.sdk.resources.fixtures import Fixtures
... fixtures_client = Fixtures(config)
... fixtures = fixtures_client.get(
... vessel_types_cpp = [VesselTypesCPP.MR],
... statuses = [FixturesStatuses.InProgress],
... columns=[
...         'reportedDate',
...         'vesselName',
...         'productName',
...         'origin',
...         'destination',
...         'status',
...         'vesselTypeCpp',
... ]
... )

Reported date

Vessel

Product

Origin

Destination

Status

Vessel Type CPP

2022-10-27

Baltic Advance

ULSD

Sidi Kerir

Koper

In Progress

MR

2022-10-27

Libera

Gasoline

Burgas

Libya

In Progress

MR

2022-10-27

Maria M

Gasoline

Petromidia

Corinth

In Progress

MR

2022-10-27

Magnifica

Gasoline

Burgas

Koper

In Progress

MR

2022-10-27

Janine K

Naphtha

Tuapse

Skhira

In Progress

MR

Return type

DataFrame

get_columns()[source]

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

Examples

>>> from kpler.sdk.resources.fixtures import Fixtures
...   fixtures_client = Fixtures(config)
...   fixtures_client.get_columns()

id

name

description

deprecated

type

reportedDate

Reported date

None

False

date yyyy-MM-dd

vesselName

Vessel

None

False

string

vesselImo

IMO

None

False

long

productQuantityInTons

Quantity (t)

None

False

double

vesselDeadweight

Deadweight (t)

None

False

long

Return type

DataFrame

class kpler.sdk.VesselTypesCPP(value)[source]
GP = 'GP'
LR1 = 'LR1'
LR2 = 'LR2'
LR3 = 'LR3'
MR = 'MR'
VLCC = 'VLCC'
class kpler.sdk.VesselTypesOil(value)[source]
Aframax = 'Aframax'
Panamax = 'Panamax'
ProductTanker = 'Product Tanker'
Suezmax = 'Suezmax'
ULCC = 'ULCC'
VLCC = 'VLCC'
class kpler.sdk.FixturesStatuses(value)[source]
Cancelled = 'cancelled'
Failed = 'failed'
Finished = 'finished'
FullyFixed = 'fully fixed'
InProgress = 'in progress'
OnSubs = 'on subs'