vortexasdk.api.voyages

CongestionBreakdownItem

CongestionBreakdownItem(
    *, avg_waiting_time: typing.Optional[float],
    vessel_dwt: typing.Optional[int],
    vessel_cubic_capacity: typing.Optional[int],
    vessel_count: typing.Optional[int], cargo_quantity: typing.Optional[int],
    avg_waiting_time_laden: typing.Optional[float],
    vessel_dwt_laden: typing.Optional[int],
    vessel_cubic_capacity_laden: typing.Optional[int],
    vessel_count_laden: typing.Optional[int],
    avg_waiting_time_ballast: typing.Optional[float],
    vessel_dwt_ballast: typing.Optional[int],
    vessel_cubic_capacity_ballast: typing.Optional[int],
    vessel_count_ballast: typing.Optional[int], location_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithListLayer]]
)

Congestion breakdown shows various stats of vessels in congestion.

model_config

VoyagesVesselEntity

VoyagesVesselEntity(
  *, id: str, name: typing.Optional[str],
  dead_weight: typing.Optional[int], vessel_class: typing.Optional[str],
  classes:
    typing.Optional[typing.List[vortexasdk.api.shared_types.VesselClassEntry]],
  imo: typing.Optional[int], mmsi: typing.Optional[int],
  call_sign: typing.Optional[str], cubic_capacity: typing.Optional[int],
  year: typing.Optional[int],
  flag: typing.Optional[typing.List[vortexasdk.api.shared_types.Flag]],
  scrubber:
    typing.Optional[typing.List[vortexasdk.api.shared_types.Scrubber]],
  ice_class: typing.Optional[str], propulsion: typing.Optional[str],
  tags: typing.Optional[typing.List[vortexasdk.api.shared_types.Tag]],
  vessel_risk_level: typing.Optional[str])

A VoyagesVesselEntity represents a vessel record used in Voyages.

Vessel Entities Further Documentation

model_config

VoyageVesselEvent

VoyageVesselEvent(
    *, event_id: typing.Optional[str], value: typing.Optional[str],
    event_group: typing.Optional[str], event_type: typing.Optional[str],
    location_id: typing.Optional[str], start_timestamp: typing.Optional[str],
    end_timestamp: typing.Optional[str], activity: typing.Optional[str],
    odometer_start: typing.Optional[int], odometer_end: typing.Optional[int],
    location_layer: typing.Optional[typing.List[str]],
    cargo_movement_id: typing.Optional[typing.List[str]],
    sts_event_counterparty_vessel_id: typing.Optional[str],
    waiting_event_target_geography_id: typing.Optional[str],
    fixture_event_fixing_timestamp: typing.Optional[str],
    tags: typing.Optional[typing.List[vortexasdk.api.shared_types.Tag]],
    probability: typing.Optional[float], location_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]],
    is_open_event: typing.Optional[bool],
    waiting_event_target_geography_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]]
)

A vessel event represents an activity that a vessel has performed during a voyage

Voyage Events Further Documentation

model_config

VoyageCargoEvent

VoyageCargoEvent(
  *, event_id: typing.Optional[str], value: typing.Optional[str],
  event_group: typing_extensions.Literal['derived'],
  event_type: typing.Optional[str],
  cargo_movement_id: typing.Optional[str],
  cargo_origin_id: typing.Optional[str],
  product_id: typing.Optional[str],
  quantity_tonnes: typing.Optional[int],
  quantity_barrels: typing.Optional[int],
  quantity_cubic_metres: typing.Optional[int],
  start_timestamp: typing.Optional[str],
  end_timestamp: typing.Optional[str], activity: typing.Optional[str],
  odometer_start: typing.Optional[int],
  odometer_end: typing.Optional[int],
  cargo_destination_id: typing.Optional[str],
  tonne_miles: typing.Optional[float], product_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]],
  cargo_origin_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]],
  cargo_destination_details:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]],
  is_open_event: typing.Optional[bool])

Cargo events relate to the movement of cargo during the voyage.

Voyage Events Further Documentation

model_config

VoyageStatusEvent

VoyageStatusEvent(*, event_id: typing.Optional[str],
                  event_group: typing_extensions.Literal['derived'],
                  event_type: typing.Optional[str],
                  activity: typing.Optional[str],
                  value: typing.Optional[str],
                  source_event_id: typing.Optional[str],
                  end_timestamp: typing.Optional[str],
                  start_timestamp: typing.Optional[str],
                  is_open_event: typing.Optional[bool])

Status events describe the status of the voyage at a given period.

Voyage Events Further Documentation

model_config

VoyageEnrichedItem

VoyageEnrichedItem(
  *, voyage_id: str, vessel_id: str,
  schema_version: typing.Optional[str],
  start_event_id: typing.Optional[str],
  vessel: typing.Optional[vortexasdk.api.voyages.VoyagesVesselEntity],
  start_timestamp: typing.Optional[str],
  end_timestamp: typing.Optional[str],
  end_event_id: typing.Optional[str],
  previous_voyage_id: typing.Optional[str],
  next_voyage_id: typing.Optional[str],
  latest_product_ids: typing.Optional[typing.List[str]],
  tags: typing.Optional[typing.List[vortexasdk.api.shared_types.Tag]],
  tonne_miles: typing.Optional[float], corporate_entities:
    typing.Optional[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayerAndTimespan]],
  odometer_start: typing.Optional[int],
  odometer_end: typing.Optional[int], events:
    typing.Optional[typing.List[typing.Union[vortexasdk.api.voyages.VoyageVesselEvent, vortexasdk.api.voyages.VoyageCargoEvent, vortexasdk.api.voyages.VoyageStatusEvent, NoneType]]],
  latest_product_details:
    typing.Optional[typing.List[typing.List[vortexasdk.api.shared_types.EntityWithSingleLayer]]],
  voyage_status: str)

A voyage is defined as a continuous period of time when the vessel is either laden or ballast.

Each voyage is made up of multiple voyage events which describe the activity of the vessel while it is laden or ballast.

Voyages Further Documentation

model_config