vortexasdk.api.cargo_movement

RawLocations

RawLocations(*, probability: typing.Optional[float],
             location_id: typing.Optional[str])

model_config

CargoPortLoadEvent

CargoPortLoadEvent(
  *, vessel_id: typing.Optional[str],
  start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_port_load_event'],
  location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  probability: typing.Optional[float],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoFSOLoadEvent

CargoFSOLoadEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_fso_load_event'],
  location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  probability: typing.Optional[float],
  fso_vessel_id: typing.Optional[str],
  fso_vessel_name: typing.Optional[str],
  to_vessel_id: typing.Optional[str],
  to_vessel_name: typing.Optional[str],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoPortUnloadEvent

CargoPortUnloadEvent(
  *, vessel_id: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_port_unload_event'],
  location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  probability: typing.Optional[float],
  end_timestamp: typing.Optional[str], raw_locations:
    typing.Optional[typing.List[vortexasdk.api.cargo_movement.RawLocations]],
  pos: typing.Optional[typing.List[float]],
  start_timestamp: typing.Optional[str],
  restricted: typing.Optional[bool])

model_config

CargoFSOUnloadEvent

CargoFSOUnloadEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_fso_unload_event'],
  location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  probability: typing.Optional[float],
  fso_vessel_id: typing.Optional[str],
  fso_vessel_name: typing.Optional[str],
  from_vessel_id: typing.Optional[str],
  from_vessel_name: typing.Optional[str],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoFixtureEvent

CargoFixtureEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_fixture_event'],
  end_timestamp: typing.Optional[str])

model_config

CargoSTSEvent

CargoSTSEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_sts_event'], location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  to_vessel_id: typing.Optional[str],
  to_vessel_name: typing.Optional[str],
  from_vessel_id: typing.Optional[str],
  from_vessel_name: typing.Optional[str],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoStorageEvent

CargoStorageEvent(
  *, vessel_id: typing.Optional[str],
  start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_storage_event'], location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  vessel_class: typing.Optional[str],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoWaypointEvent

CargoWaypointEvent(
  *, vessel_id: typing.Optional[str],
  start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_waypoint_event'],
  location:
    typing.Optional[typing.List[vortexasdk.api.geography.GeographyEntity]],
  probability: typing.Optional[float],
  end_timestamp: typing.Optional[str],
  pos: typing.Optional[typing.List[float]])

model_config

CargoTransitingEvent

CargoTransitingEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_transiting_event'],
  end_timestamp: typing.Optional[str])

model_config

CargoOilOnWaterEvent

CargoOilOnWaterEvent(
  *, start_timestamp: typing.Optional[str],
  event_type: typing_extensions.Literal['cargo_oil_on_water_event'],
  end_timestamp: typing.Optional[str])

model_config

ParentID

ParentID(*, id: typing.Optional[str],
         splinter_timestamp: typing.Optional[str])

cargo_movement_id may change under certain conditions. ParentID contains an id, a previous id of the cargo movement, and a splinter_timestamp, the time at which the id change occurred.

Cargo Movement Further Documentation

model_config

CargoMovementProductEntry

CargoMovementProductEntry(*, probability: typing.Optional[float],
                          source: typing.Optional[str],
                          id: typing.Optional[str],
                          layer: typing.Optional[str],
                          label: typing.Optional[str])

model_config

CargoMovement

CargoMovement(
    *, cargo_movement_id: str, quantity: typing.Optional[int],
    status: typing.Optional[str],
    vessels: typing.Optional[typing.List[vortexasdk.api.vessel.VesselEntity]],
    product:
    typing.Optional[typing.List[vortexasdk.api.cargo_movement.CargoMovementProductEntry]],
    parent_ids:
    typing.Optional[typing.List[vortexasdk.api.cargo_movement.ParentID]],
    events:
    typing.Optional[typing.List[typing.Annotated[typing.Union[vortexasdk.api.cargo_movement.CargoPortLoadEvent, vortexasdk.api.cargo_movement.CargoFSOLoadEvent, vortexasdk.api.cargo_movement.CargoPortUnloadEvent, vortexasdk.api.cargo_movement.CargoFSOUnloadEvent, vortexasdk.api.cargo_movement.CargoFixtureEvent, vortexasdk.api.cargo_movement.CargoSTSEvent, vortexasdk.api.cargo_movement.CargoStorageEvent, vortexasdk.api.cargo_movement.CargoWaypointEvent, vortexasdk.api.cargo_movement.CargoTransitingEvent, vortexasdk.api.cargo_movement.CargoOilOnWaterEvent], FieldInfo(annotation=NoneType, required=True, discriminator='event_type')]]]
)

Cargo movements are the base data set the Vortexa API is centred around.

Each movement represents a journey of a certain quantity of a product between places.

Cargo Movement Further Documentation

model_config