vortexasdk.endpoints.vessel_movements
Try me out in your browser:
VesselMovements
VesselMovements(self)
Vessel Movements Endpoint, use this to search through Vortexa's VesselMovements.
A VesselMovement represents a single vessel moving between two locations.
- The vessel may carry one cargo, many cargoes (coloads), or zero cargos (ballast).
- The start and end locations for a VesselMovement may be on land (loadings and discharges), they may be STS Zones (STS events), or they may be Floating Storage.
A detailed explanation of Cargo/Vessel Movements can be found here.
search
VesselMovements.search(self, filter_time_min: datetime.datetime = datetime.datetime(2019, 10, 1, 0, 0), filter_time_max: datetime.datetime = datetime.datetime(2019, 10, 1, 1, 0), unit: str = 'b', filter_activity: str = None, filter_charterers: Union[str, List[str]] = None, filter_destinations: Union[str, List[str]] = None, filter_origins: Union[str, List[str]] = None, filter_owners: Union[str, List[str]] = None, filter_products: Union[str, List[str]] = None, filter_vessels: Union[str, List[str]] = None, filter_vessel_classes: Union[str, List[str]] = None, filter_vessel_status: Union[str, List[str]] = None, filter_vessel_age_min: int = None, filter_vessel_age_max: int = None, filter_vessel_scrubbers: str = 'disabled', filter_vessel_flags: Union[str, List[str]] = None, filter_vessel_ice_class: Union[str, List[str]] = None, filter_vessel_propulsion: Union[str, List[str]] = None, exclude_origins: Union[str, List[str]] = None, exclude_destinations: Union[str, List[str]] = None, exclude_products: Union[str, List[str]] = None, exclude_vessels: Union[str, List[str]] = None, exclude_vessel_classes: Union[str, List[str]] = None, exclude_charterers: Union[str, List[str]] = None, exclude_owners: Union[str, List[str]] = None, exclude_vessel_flags: Union[str, List[str]] = None, exclude_vessel_ice_class: Union[str, List[str]] = None, exclude_vessel_propulsion: Union[str, List[str]] = None) -> vortexasdk.endpoints.vessel_movements_result.VesselMovementsResult
Find VesselMovements matching the given search parameters.
Arguments
-
filter_activity: Movement activity on which to base the time filter. Must be one of:
'loading_state'
,'loading_start'
,'loading_end'
,'identified_for_loading_state'
,'unloading_state'
,'unloading_start'
,'unloading_end'
,'unloaded_state'
,'storing_state'
,'storing_start'
,'storing_end'
,'transiting_state'
,'any_activity'
. -
filter_time_min: The UTC start date of the time filter.
-
filter_time_max: The UTC end date of the time filter.
-
unit: Unit of measurement. Enter 'b' for barrels or 't' for tonnes.
-
filter_charterers: A charterer ID, or list of charterer IDs to filter on.
-
filter_destinations: A geography ID, or list of geography IDs to filter on.
-
filter_origins: A geography ID, or list of geography IDs to filter on.
-
filter_owners: An corporation ID, or list of corporation IDs to filter on.
-
filter_products: A product ID, or list of product IDs to filter on.
-
filter_vessels: A vessel ID, or list of vessel IDs to filter on.
-
filter_vessel_classes: A vessel class, or list of vessel classes to filter on.
-
filter_vessel_status: A vessel status, or array of vessel statuses on which to base the filter. Enter 'vessel_status_ballast' for ballast vessels, 'vessel_status_laden_known' for laden vessels with known cargo (i.e. a type of cargo that Vortexa currently tracks) or 'vessel_status_laden_unknown' for laden vessels with unknown cargo (i.e. a type of cargo that Vortexa currently does not track).
-
filter_vessel_age_min: A number between 1 and 100 (representing years).
-
filter_vessel_age_max: A number between 1 and 100 (representing years).
-
filter_vessel_scrubbers: Either inactive 'disabled', or included 'inc' or excluded 'exc'.
-
filter_vessel_flags: A geography ID, or list of geography IDs to filter on.
-
filter_vessel_ice_class: An attribute ID, or list of attribute IDs to filter on.
-
filter_vessel_propulsion: An attribute ID, or list of attribute IDs to filter on.
-
exclude_origins: A geography ID, or list of geography IDs to exclude.
-
exclude_destinations: A geography ID, or list of geography IDs to exclude.
-
exclude_products: A product ID, or list of product IDs to exclude.
-
exclude_vessels: A vessel ID, or list of vessel IDs to exclude.
-
exclude_vessel_classes: A vessel class, or list of vessel classes to exclude.
-
exclude_charterers: A charterer ID, or list of charterer IDs to exclude.
-
exclude_owners: An owner ID, or list of owner IDs to exclude.
-
exclude_vessel_flags: A geography ID, or list of geography IDs to exclude.
-
exclude_vessel_ice_class: An attribute ID, or list of attribute IDs to exclude.
-
exclude_vessel_propulsion: An attribute ID, or list of attribute IDs to exclude.
Returns
VesselMovementsResult
, containing all the vessel movements matching the given search terms.
Example
Let's search for all vessels that departed from Rotterdam [NL]
on the morning of 1st December 2018.
>>> from vortexasdk import VesselMovements, Geographies
>>> rotterdam = [g.id for g in Geographies().search("rotterdam").to_list() if "port" in g.layer]
>>> df = VesselMovements().search(
... filter_time_min=datetime(2017, 10, 1, 0, 0),
... filter_time_max=datetime(2017, 10, 1, 0, 10),
... filter_origins=rotterdam
... ).to_df().head(2)
start_timestamp | end_timestamp | vessel.imo | vessel.name | vessel.vessel_class | origin.location.country.label | origin.location.port.label | destination.location.country.label | destination.location.port.label | cargoes.0.quantity | cargoes.0.product.grade.label | |
---|---|---|---|---|---|---|---|---|---|---|---|
0 | 2017-09-30T15:30:27+0000 | 2017-10-03T01:46:06+0000 | 9.21091e+06 | ADEBOMI 3 | handysize | Netherlands | Rotterdam [NL] | Netherlands | Rotterdam [NL] | nan | nan |
1 | 2017-08-29T14:51:32+0000 | 2017-10-04T14:46:21+0000 | 9.64544e+06 | AEGEAN VISION | suezmax | Netherlands | Rotterdam [NL] | Singapore | Singapore [SG] | 852261 | High Sulphur |
Vessel Movements Endpoint Further Documentation
vortexasdk.endpoints.vessel_movements_result
VesselMovementsResult
VesselMovementsResult(self, _records: List) -> None
Container class holdings search results returns from the vessel movements endpoint.
This class has two methods, to_list()
, and to_df()
, allowing search results to be represented as a list of VesselMovement
s,
or as a pd.DataFrame
, respectively.
to_list
VesselMovementsResult.to_list(self) -> List[vortexasdk.api.vessel_movement.VesselMovement]
Represent vessel movements as a list of VesselMovementEntity
s.
to_df
VesselMovementsResult.to_df(self, columns=None) -> pandas.core.frame.DataFrame
Represent vessel movements as a pd.DataFrame
.
Arguments
- columns: Output columns present in the
pd.DataFrame
. Entercolumns='all'
to return all available columns. Entercolumns=None
to usevessel_movements.DEFAULT_COLUMNS
.
Returns
pd.DataFrame
, one row per VesselMovement
.
Notes
By default, the columns returned are something along the lines of.
DEFAULT_COLUMNS = [
'vessel.imo',
'vessel.name',
'vessel.vessel_class',
'origin.event_type',
'origin.location.port.label',
'origin.location.country.label',
'destination.event_type',
'destination.location.port.label',
'destination.location.country.label',
'cargoes.0.product.group_product.label,'
'cargoes.0.product.category.label',
'cargoes.0.product.grade.label',
'cargoes.0.quantity',
'start_timestamp',
'end_timestamp',
]
The exact default columns used can be found at vessel_movements.DEFAULT_COLUMNS
A near complete list of columns is given below
[
cargoes.0.cargo_movement_id
cargoes.0.product.category.id
cargoes.0.product.category.label
cargoes.0.product.category.layer
cargoes.0.product.category.probability
cargoes.0.product.category.source
cargoes.0.product.grade.id
cargoes.0.product.grade.label
cargoes.0.product.grade.layer
cargoes.0.product.grade.probability
cargoes.0.product.grade.source
cargoes.0.product.group.id
cargoes.0.product.group.label
cargoes.0.product.group.layer
cargoes.0.product.group.probability
cargoes.0.product.group.source
cargoes.0.product.group_product.id
cargoes.0.product.group_product.label
cargoes.0.product.group_product.layer
cargoes.0.product.group_product.probability
cargoes.0.product.group_product.source
cargoes.0.quantity
cargoes.1.cargo_movement_id
cargoes.1.product.category.id
cargoes.1.product.category.label
cargoes.1.product.category.layer
cargoes.1.product.category.probability
cargoes.1.product.category.source
cargoes.1.product.grade.id
cargoes.1.product.grade.label
cargoes.1.product.grade.layer
cargoes.1.product.grade.probability
cargoes.1.product.grade.source
cargoes.1.product.group.id
cargoes.1.product.group.label
cargoes.1.product.group.layer
cargoes.1.product.group.probability
cargoes.1.product.group.source
cargoes.1.product.group_product.id
cargoes.1.product.group_product.label
cargoes.1.product.group_product.layer
cargoes.1.product.group_product.probability
cargoes.1.product.group_product.source
cargoes.1.quantity
cargoes.2.cargo_movement_id
cargoes.2.product.category.id
cargoes.2.product.category.label
cargoes.2.product.category.layer
cargoes.2.product.category.probability
cargoes.2.product.category.source
cargoes.2.product.grade.id
cargoes.2.product.grade.label
cargoes.2.product.grade.layer
cargoes.2.product.grade.probability
cargoes.2.product.grade.source
cargoes.2.product.group.id
cargoes.2.product.group.label
cargoes.2.product.group.layer
cargoes.2.product.group.probability
cargoes.2.product.group.source
cargoes.2.product.group_product.id
cargoes.2.product.group_product.label
cargoes.2.product.group_product.layer
cargoes.2.product.group_product.probability
cargoes.2.product.group_product.source
cargoes.2.quantity
cargoes.3.cargo_movement_id
cargoes.3.product.category.id
cargoes.3.product.category.label
cargoes.3.product.category.layer
cargoes.3.product.category.probability
cargoes.3.product.category.source
cargoes.3.product.grade.id
cargoes.3.product.grade.label
cargoes.3.product.grade.layer
cargoes.3.product.grade.probability
cargoes.3.product.grade.source
cargoes.3.product.group.id
cargoes.3.product.group.label
cargoes.3.product.group.layer
cargoes.3.product.group.probability
cargoes.3.product.group.source
cargoes.3.product.group_product.id
cargoes.3.product.group_product.label
cargoes.3.product.group_product.layer
cargoes.3.product.group_product.probability
cargoes.3.product.group_product.source
cargoes.3.quantity
cargoes.4.cargo_movement_id
cargoes.4.product.category.id
cargoes.4.product.category.label
cargoes.4.product.category.layer
cargoes.4.product.category.probability
cargoes.4.product.category.source
cargoes.4.product.grade.id
cargoes.4.product.grade.label
cargoes.4.product.grade.layer
cargoes.4.product.grade.probability
cargoes.4.product.grade.source
cargoes.4.product.group.id
cargoes.4.product.group.label
cargoes.4.product.group.layer
cargoes.4.product.group.probability
cargoes.4.product.group.source
cargoes.4.product.group_product.id
cargoes.4.product.group_product.label
cargoes.4.product.group_product.layer
cargoes.4.product.group_product.probability
cargoes.4.product.group_product.source
cargoes.4.quantity
cargoes.5.cargo_movement_id
cargoes.5.product.category.id
cargoes.5.product.category.label
cargoes.5.product.category.layer
cargoes.5.product.category.probability
cargoes.5.product.category.source
cargoes.5.product.grade.id
cargoes.5.product.grade.label
cargoes.5.product.grade.layer
cargoes.5.product.grade.probability
cargoes.5.product.grade.source
cargoes.5.product.group.id
cargoes.5.product.group.label
cargoes.5.product.group.layer
cargoes.5.product.group.probability
cargoes.5.product.group.source
cargoes.5.product.group_product.id
cargoes.5.product.group_product.label
cargoes.5.product.group_product.layer
cargoes.5.product.group_product.probability
cargoes.5.product.group_product.source
cargoes.5.quantity
cargoes.6.cargo_movement_id
cargoes.6.product.category.id
cargoes.6.product.category.label
cargoes.6.product.category.layer
cargoes.6.product.category.probability
cargoes.6.product.category.source
cargoes.6.product.grade.id
cargoes.6.product.grade.label
cargoes.6.product.grade.layer
cargoes.6.product.grade.probability
cargoes.6.product.grade.source
cargoes.6.product.group.id
cargoes.6.product.group.label
cargoes.6.product.group.layer
cargoes.6.product.group.probability
cargoes.6.product.group.source
cargoes.6.product.group_product.id
cargoes.6.product.group_product.label
cargoes.6.product.group_product.layer
cargoes.6.product.group_product.probability
cargoes.6.product.group_product.source
cargoes.6.quantity
cargoes.7.cargo_movement_id
cargoes.7.product.category.id
cargoes.7.product.category.label
cargoes.7.product.category.layer
cargoes.7.product.category.probability
cargoes.7.product.category.source
cargoes.7.product.grade.id
cargoes.7.product.grade.label
cargoes.7.product.grade.layer
cargoes.7.product.grade.probability
cargoes.7.product.grade.source
cargoes.7.product.group.id
cargoes.7.product.group.label
cargoes.7.product.group.layer
cargoes.7.product.group.probability
cargoes.7.product.group.source
cargoes.7.product.group_product.id
cargoes.7.product.group_product.label
cargoes.7.product.group_product.layer
cargoes.7.product.group_product.probability
cargoes.7.product.group_product.source
cargoes.7.quantity
cargoes.8.cargo_movement_id
cargoes.8.product.category.id
cargoes.8.product.category.label
cargoes.8.product.category.layer
cargoes.8.product.category.probability
cargoes.8.product.category.source
cargoes.8.product.grade.id
cargoes.8.product.grade.label
cargoes.8.product.grade.layer
cargoes.8.product.grade.probability
cargoes.8.product.grade.source
cargoes.8.product.group.id
cargoes.8.product.group.label
cargoes.8.product.group.layer
cargoes.8.product.group.probability
cargoes.8.product.group.source
cargoes.8.product.group_product.id
cargoes.8.product.group_product.label
cargoes.8.product.group_product.layer
cargoes.8.product.group_product.probability
cargoes.8.product.group_product.source
cargoes.8.quantity
cargoes.9.cargo_movement_id
cargoes.9.product.category.id
cargoes.9.product.category.label
cargoes.9.product.category.layer
cargoes.9.product.category.probability
cargoes.9.product.category.source
cargoes.9.product.grade.id
cargoes.9.product.grade.label
cargoes.9.product.grade.layer
cargoes.9.product.grade.probability
cargoes.9.product.grade.source
cargoes.9.product.group.id
cargoes.9.product.group.label
cargoes.9.product.group.layer
cargoes.9.product.group.probability
cargoes.9.product.group.source
cargoes.9.product.group_product.id
cargoes.9.product.group_product.label
cargoes.9.product.group_product.layer
cargoes.9.product.group_product.probability
cargoes.9.product.group_product.source
cargoes.9.quantity
destination.end_timestamp
destination.event_id
destination.event_type
destination.from_vessel.id
destination.from_vessel.label
destination.from_vessel.tags.0
destination.from_vessel.tags.1
destination.location.country.id
destination.location.country.label
destination.location.country.layer
destination.location.country.probability
destination.location.country.source
destination.location.port.id
destination.location.port.label
destination.location.port.layer
destination.location.port.probability
destination.location.port.source
destination.location.region.id
destination.location.region.label
destination.location.region.layer
destination.location.region.probability
destination.location.region.source
destination.location.shipping_region.id
destination.location.shipping_region.label
destination.location.shipping_region.layer
destination.location.shipping_region.probability
destination.location.shipping_region.source
destination.location.sts_zone.id
destination.location.sts_zone.label
destination.location.sts_zone.layer
destination.location.sts_zone.probability
destination.location.sts_zone.source
destination.location.terminal.id
destination.location.terminal.label
destination.location.terminal.layer
destination.location.terminal.probability
destination.location.terminal.source
destination.location.trading_block.id
destination.location.trading_block.label
destination.location.trading_block.layer
destination.location.trading_block.probability
destination.location.trading_block.source
destination.location.trading_region.id
destination.location.trading_region.label
destination.location.trading_region.layer
destination.location.trading_region.probability
destination.location.trading_region.source
destination.location.trading_subregion.id
destination.location.trading_subregion.label
destination.location.trading_subregion.layer
destination.location.trading_subregion.probability
destination.location.trading_subregion.source
destination.pos.0
destination.pos.1
destination.start_timestamp
destination.to_vessel.id
destination.to_vessel.label
destination.to_vessel.tags.0
destination.to_vessel.tags.1
destination.to_vessel.tags.2
destination.to_vessel.tags.3
destination.to_vessel.tags.4
destination.to_vessel.tags.5
destination.to_vessel.tags.6
destination.to_vessel.tags.7
destination.to_vessel.tags.8
destination.to_vessel.tags.9
end_timestamp
origin.end_timestamp
origin.event_id
origin.event_type
origin.from_vessel.id
origin.from_vessel.label
origin.from_vessel.tags.0
origin.from_vessel.tags.1
origin.from_vessel.tags.2
origin.from_vessel.tags.3
origin.from_vessel.tags.4
origin.from_vessel.tags.5
origin.location.country.id
origin.location.country.label
origin.location.country.layer
origin.location.country.probability
origin.location.country.source
origin.location.port.id
origin.location.port.label
origin.location.port.layer
origin.location.port.probability
origin.location.port.source
origin.location.region.id
origin.location.region.label
origin.location.region.layer
origin.location.region.probability
origin.location.region.source
origin.location.shipping_region.id
origin.location.shipping_region.label
origin.location.shipping_region.layer
origin.location.shipping_region.probability
origin.location.shipping_region.source
origin.location.sts_zone.id
origin.location.sts_zone.label
origin.location.sts_zone.layer
origin.location.sts_zone.probability
origin.location.sts_zone.source
origin.location.terminal.id
origin.location.terminal.label
origin.location.terminal.layer
origin.location.terminal.probability
origin.location.terminal.source
origin.location.trading_block.id
origin.location.trading_block.label
origin.location.trading_block.layer
origin.location.trading_block.probability
origin.location.trading_block.source
origin.location.trading_region.id
origin.location.trading_region.label
origin.location.trading_region.layer
origin.location.trading_region.probability
origin.location.trading_region.source
origin.location.trading_subregion.id
origin.location.trading_subregion.label
origin.location.trading_subregion.layer
origin.location.trading_subregion.probability
origin.location.trading_subregion.source
origin.pos.0
origin.pos.1
origin.start_timestamp
origin.to_vessel.id
origin.to_vessel.label
origin.to_vessel.tags.0
origin.to_vessel.tags.1
origin.to_vessel.tags.2
origin.to_vessel.tags.3
start_timestamp
vessel.corporate_entities.charterer.id
vessel.corporate_entities.charterer.label
vessel.corporate_entities.charterer.layer
vessel.corporate_entities.charterer.probability
vessel.corporate_entities.charterer.source
vessel.corporate_entities.commercial_owner.id
vessel.corporate_entities.commercial_owner.label
vessel.corporate_entities.commercial_owner.layer
vessel.corporate_entities.commercial_owner.probability
vessel.corporate_entities.commercial_owner.source
vessel.corporate_entities.time_charterer.end_timestamp
vessel.corporate_entities.time_charterer.id
vessel.corporate_entities.time_charterer.label
vessel.corporate_entities.time_charterer.layer
vessel.corporate_entities.time_charterer.probability
vessel.corporate_entities.time_charterer.source
vessel.corporate_entities.time_charterer.start_timestamp
vessel.cubic_capacity
vessel.dwt
vessel.id
vessel.imo
vessel.mmsi
vessel.name
vessel.status
vessel.tags.0.end_timestamp
vessel.tags.0.start_timestamp
vessel.tags.0.tag
vessel.tags.1.end_timestamp
vessel.tags.1.start_timestamp
vessel.tags.1.tag
vessel.tags.2.end_timestamp
vessel.tags.2.start_timestamp
vessel.tags.2.tag
vessel.tags.3.end_timestamp
vessel.tags.3.start_timestamp
vessel.tags.3.tag
vessel.tags.4.end_timestamp
vessel.tags.4.start_timestamp
vessel.tags.4.tag
vessel.vessel_class
vessel_movement_id
voyage_id
]