vortexasdk.endpoints.voyages_search_enriched
Try me out in your browser:
VoyagesSearchEnriched
VoyagesSearchEnriched(self)
search
VoyagesSearchEnriched.search(self, order: str = None, order_direction: str = None, unit: str = None, columns: Union[str, List[str]] = None, time_min: datetime.datetime = datetime.datetime(2022, 1, 1, 0, 0), time_max: datetime.datetime = datetime.datetime(2022, 1, 1, 1, 0), voyage_id: Union[str, List[str]] = None, cargo_movement_id: Union[str, List[str]] = None, voyage_status: Union[str, List[str]] = None, voyage_status_excluded: Union[str, List[str]] = None, movement_status: Union[str, List[str]] = None, movement_status_excluded: Union[str, List[str]] = None, cargo_status: Union[str, List[str]] = None, cargo_status_excluded: Union[str, List[str]] = None, location_status: Union[str, List[str]] = None, location_status_excluded: Union[str, List[str]] = None, commitment_status: Union[str, List[str]] = None, commitment_status_excluded: Union[str, List[str]] = None, exclude_overlapping_entries: bool = None, products: Union[str, List[str]] = None, products_excluded: Union[str, List[str]] = None, latest_products: Union[str, List[str]] = None, latest_products_excluded: Union[str, List[str]] = None, charterers: Union[str, List[str]] = None, charterers_excluded: Union[str, List[str]] = None, effective_controllers: Union[str, List[str]] = None, effective_controllers_excluded: Union[str, List[str]] = None, origins: Union[str, List[str]] = None, origins_excluded: Union[str, List[str]] = None, destinations: Union[str, List[str]] = None, destinations_excluded: Union[str, List[str]] = None, locations: Union[str, List[str]] = None, locations_excluded: Union[str, List[str]] = None, vessels: Union[str, List[str]] = None, vessels_excluded: Union[str, List[str]] = None, flags: Union[str, List[str]] = None, flags_excluded: Union[str, List[str]] = None, ice_class: Union[str, List[str]] = None, ice_class_excluded: Union[str, List[str]] = None, vessel_propulsion: Union[str, List[str]] = None, vessel_propulsion_excluded: Union[str, List[str]] = None, vessel_age_min: int = None, vessel_age_max: int = None, vessel_dwt_min: int = None, vessel_dwt_max: int = None, vessel_cbm_min: int = None, vessel_cbm_max: int = None, vessel_wait_time_min: int = None, vessel_wait_time_max: int = None, vessel_scrubbers: str = None, vessel_tags: Union[vortexasdk.api.shared_types.Tag, List[vortexasdk.api.shared_types.Tag]] = None, vessel_tags_excluded: Union[vortexasdk.api.shared_types.Tag, List[vortexasdk.api.shared_types.Tag]] = None, vessel_risk_level: Union[str, List[str]] = None, vessel_risk_level_excluded: Union[str, List[str]] = None, has_ship_to_ship: str = None, has_charterer: str = None, intra_movements: str = None, voyage_date_range_activity: vortexasdk.api.shared_types.VoyageDateRangeActivity = None, origin_behaviour: vortexasdk.api.shared_types.OriginBehaviour = None, destination_behaviour: vortexasdk.api.shared_types.DestinationBehaviour = None, event_types: Union[str, List[str]] = None, event_types_excluded: Union[str, List[str]] = None, congestion_target_location: Union[str, List[str]] = None, congestion_target_location_excluded: Union[str, List[str]] = None) -> Union[vortexasdk.endpoints.voyages_search_enriched_result.VoyagesSearchEnrichedFlattenedResult, vortexasdk.endpoints.voyages_search_enriched_result.VoyagesSearchEnrichedListResult]
Returns one record per voyage, containing a selection of information about the voyage.
NOTE: To display results as a list (to_list()), please set the columns parameter to None. To display results as dataframe (to_df()), please set the columns parameter to all or a list of selected columns.
Arguments
-
time_min: The UTC start date of the time filter.
-
time_max: The UTC end date of the time filter.
-
voyage_id: An array of unique voyage ID(s) to filter on.
-
cargo_movement_id: An array of unique cargo movement ID(s) to filter on.
-
voyage_status: A voyage status, or list of voyage statuses to filter on. Can be one of:
'ballast','laden'. -
voyage_status_excluded: A voyage status, or list of voyage statuses to exclude.
-
movement_status: A movement status, or list of movement statuses to filter on. Can be one of:
'moving','stationary','waiting','congestion','slow'. -
movement_status_excluded: A movement status, or list of movement statuses to exclude.
-
cargo_status: A cargo status, or list of cargo statuses to filter on. Can be one of:
'in-transit','floating-storage','loading','discharging'. -
cargo_status_excluded: A cargo status, or list of cargo statuses to exclude.
-
location_status: A location status, or list of location statuses to filter on. Can be one of:
'berth','anchorage-zone','dry-dock','on-the-sea'. -
location_status_excluded: A location status, or list of location statuses to exclude.
-
commitment_status: A commitment status, or list of commitment statuses to filter on. Can be one of:
'committed','uncommitted','open','unknown'. -
commitment_status_excluded: A commitment status, or list of commitment statuses to exclude.
-
exclude_overlapping_entries: A boolean to only consider the latest voyage in days where two or more Voyages overlap.
-
products: A product ID, or list of product IDs to filter on.
-
products_excluded: A product ID, or list of product IDs to exclude.
-
latest_products: A product ID, or list of product IDs of the latest cargo on board to filter on.
-
latest_products_excluded: A product ID, or list of product IDs of the latest cargo on board to exclude.
-
charterers: A charterer ID, or list of charterer IDs to filter on.
-
charterers_excluded: A charterer ID, or list of charterer IDs to exclude.
-
effective_controllers: A vessel effective controller ID, or list of vessel effective controller IDs to filter on.
-
effective_controllers_excluded: A effective controller ID, or list of effective controller IDs to exclude.
-
origins: An origin ID, or list of origin IDs for all the cargoes of a voyage to filter on.
-
origins_excluded: An origin ID, or list of origin IDs for all the cargoes of a voyage to exclude.
-
destinations: A destination ID, or list of destination IDs for all the cargoes of a voyage to filter on.
-
destinations_excluded: A destination ID, or list of destination IDs for all the cargoes of a voyage to exclude.
-
locations: A location ID, or list of location IDs to filter on.
-
locations_excluded: A location ID, or list of location IDs to exclude.
-
vessels: A vessel ID or vessel class, or list of vessel IDs/vessel classes to filter on.
-
vessels_excluded: A vessel ID or vessel class, or list of vessel IDs/vessel classes to exclude.
-
flags: A flag, or list of flags to filter on.
-
flags_excluded: A flag, or list of flags to exclude.
-
ice_class: An ice class, or list of ice classes to filter on.
-
ice_class_excluded: An ice class, or list of ice classes to ęxclude.
-
vessel_propulsion: A propulsion method, or list of propulsion methods to filter on.
-
vessel_propulsion_excluded: A propulsion method, or list of propulsion methods to ęxclude.
-
vessel_age_min: A number between 1 and 100 (representing years).
-
vessel_age_max: A number between 1 and 100 (representing years).
-
vessel_dwt_min: A number representing minimum deadweight tonnage of a vessel.
-
vessel_dwt_max: A number representing maximum deadweight tonnage of a vessel.
-
vessel_cdm_min: A number representing minimum cubic capacity of a vessel.
-
vessel_cbm_max: A number representing maximum cubic capacity of a vessel.
-
vessel_wait_time_min: A number representing a minimum number of days until a vessel becomes available.
-
vessel_wait_time_max: A number representing a maximum number of days until a vessel becomes available.
-
vessel_scrubbers: Either inactive 'disabled', or included 'inc' or excluded 'exc'.
-
vessel_tags: A time bound vessel tag, or list of time bound vessel tags to filter on.
-
vessel_tags_excluded: A time bound vessel tag, or list of time bound vessel tags to exclude.
-
vessel_risk_level: A vessel risk level, or list of vessel risk levels to filter on.
-
vessel_risk_level_excluded: A vessel risk level, or list of vessel risk levels to exclude.
-
has_ship_to_ship: Filter data where at least one STS transfer occurs, or none. - one of
disabled,inc,exc. Passing disabled means the filter is not active. -
has_charterer: Filter data where at least one charterer is specified, or none. - one of
disabled,inc,exc. Passing disabled means the filter is not active. -
intra_movements: Filter movements based on whether the vessel started and ended in the same country, or geographical layer.
-
voyage_date_range_activity: Filter to determine how the voyages should be counted. Must be one of [
active,departures,arrivals] -
origin_behaviour: The origin behaviour determines which departure mode the
voyage_date_range_activityshould count, must be one of [first_load,any_load]. -
destination_behaviour: The destination behaviour determines which arrival mode the voyage_date_range_activity should count, must be one of [last_discharge, any_discharge].
-
event_types: A list of event types that should be included when filtering voyages, it could be
vessel,cargoorstatus. -
event_types_excluded: A list of event types that should be excluded when filtering voyages, it could be
vessel,cargoorstatus. -
order: Used to sort the returned results. Can be one of:
'vessel_name','dwt','vessel_class','start_date','end_date'. -
order_direction: Determines the direction of sorting. ‘asc’ for ascending, ‘desc’ for descending.
-
unit: Unit of measurement. Enter
'b'for barrels or't'for tonnes or'cbm'for cubic metres. -
columns: Determines what columns are visible in the output. Enter "all" for all columns, or any of:
'vessel_name','imo','dwt','capacity','vessel_class','voyage_status','cargo_status','origin','origin_shipping_region','origin_region','origin_country','origin_port','origin_terminal','destination','destination_shipping_region','destination_region','destination_country','destination_port','destination_terminal','destination_eta','charterer','effective_controller','voyage_type','quantity','latest_product','latest_product_group','latest_product_category','latest_product_grade','time_charterer','flag','scrubber','build_year','risk_rating','coating','start_date','end_date','tonne_miles','distance','voyage_id','previous_voyage_id','next_voyage_id','duration','first_origin','first_origin_shipping_region','first_origin_country','first_origin_port','first_origin_terminal','final_destination','final_destination_shipping_region','final_destination_country','final_destination_port','final_destination_terminal'. -
congestion_target_location: A list of geographical identifiers to apply to the location filter.
-
congestion_target_location_excluded: A list of geographical identifiers to exclude from the location filter.
Returns
VoyagesSearchEnrichedListResult or VoyagesSearchEnrichedFlattenedResult
Example
Voyages as of 13th Feb 2023 for vessels carrying crude departing from Rotterdam.
>>> from vortexasdk import VoyagesSearchEnriched, Geographies
>>> from datetime import datetime
>>> rotterdam = [g.id for g in Geographies().search("rotterdam").to_list() if "port" in g.layer]
>>> start = datetime(2023, 2, 13)
>>> end = datetime(2023, 2, 13, 23, 59)
>>> search_result = VoyagesSearchEnriched().search(
... time_min=start,
... time_max=end,
... origins=rotterdam,
... columns="all",
... ).to_df().head()
Gives the following result:
| | VESSEL NAME | IMO | DWT (t) | CAPACITY (cbm) | VESSEL CLASS | VOYAGE STATUS | ORIGIN | ORIGIN TERMINAL | ORIGIN PORT | ORIGIN COUNTRY | ORIGIN SHIPPING REGION | DESTINATION | DESTINATION TERMINAL | DESTINATION PORT | DESTINATION COUNTRY | DESTINATION SHIPPING REGION | START DATE | END DATE | LATEST PRODUCT | LATEST PRODUCT GROUP | LATEST PRODUCT CATEGORY | LATEST PRODUCT GRADE | QUANTITY (bbl) | CHARTERER | EFFECTIVE CONTROLLER | TIME CHARTERER | BUILD YEAR | FLAG | RISK RATING | SCRUBBERS | COATING | TONNE-MILES | DURATION (h) | DISTANCE | VOYAGE ID | PREVIOUS VOYAGE ID | NEXT VOYAGE ID | ORIGIN GEOGRAPHIC REGION | DESTINATION GEOGRAPHIC REGION | FIRST ORIGIN | FIRST ORIGIN TERMINAL | FIRST ORIGIN PORT | FIRST ORIGIN COUNTRY | FIRST ORIGIN SHIPPING REGION | FINAL DESTINATION | FINAL DESTINATION TERMINAL | FINAL DESTINATION PORT | FINAL DESTINATION COUNTRY | FINAL DESTINATION SHIPPING REGION |
|---:|:---------------------|--------:|----------:|-----------------:|:----------------|:----------------|:--------------------------------|:------------------------|:--------------------------------|:--------------------|:-------------------------|:---------------|:-----------------------|:-------------------|:----------------------|:------------------------------|:-------------|:------------|:--------------------------------|:-------------------------|:------------------------------|:-----------------------|-----------------:|:------------|:-----------------------|:-----------------|-------------:|:-------|:--------------|:------------|:----------|:--------------|---------------:|:-----------|:-----------------------------------------------------------------|:-----------------------------------------------------------------|:-----------------|:---------------------------|:--------------------------------|:------------------|:------------------------|:--------------------|:-----------------------|:-------------------------------|:--------------------|:-----------------------------|:-------------------------|:----------------------------|:------------------------------------|
| 0 | YM NEPTUNE | 9464106 | 6970 | 8091 | Tiny tanker | Laden | Frontignan [FR], Rotterdam [NL] | , Vopak Terminal Botlek | Frontignan [FR], Rotterdam [NL] | France, Netherlands | West Med, UK Cont | | | | | | 28 Dec 2022 | | Biodiesel, Other Clean Products | Clean Petroleum Products | Finished Biodiesel, Chemicals | | 19058 | | | | 2009 | MT | Low | | Coated | 15708783 | 1139 | 7570 | 0edb92ac9addd29b42ede8a8b4843ceb0edb92ac9addd29b42ede8a8b4843ceb | f2b314f245a391ee4e1ebcc41d9a2d2741526f0f3625183440e7e280092cfe91 | | Europe, Europe | | Frontignan [FR] | | Frontignan [FR] | France | West Med | | | | | |
| 1 | YASA POLARIS | 9907457 | 157300 | 167231 | Suezmax | Ballast | Rotterdam [NL] | TEAM Terminal B.V. | Rotterdam [NL] | Netherlands | UK Cont | Rotterdam [NL] | | Rotterdam [NL] | Netherlands | UK Cont | 13 Feb 2023 | | Crude | Crude/Condensates | Light-Sour | CPC Blend | 0 | | Ya-Sa Shipping | | 2021 | MH | Medium | | | | 14 | | ac6c49388567f546d4f57a3e8e8c984e2188f68407394bbe3fde99a0aaff72d7 | f9cab95f35202ab0b273d6d646202080f9cab95f35202ab0b273d6d646202080 | | Europe | Europe | Rotterdam [NL] | TEAM Terminal B.V. | Rotterdam [NL] | Netherlands | UK Cont | Rotterdam [NL] | | Rotterdam [NL] | Netherlands | UK Cont |
| 2 | XING HAI WAN | 9570113 | 6123 | 6022 | Tiny tanker | Laden | Rotterdam [NL] | Shell - Rotterdam | Rotterdam [NL] | Netherlands | UK Cont | | | | | | 07 Feb 2023 | | Asphalt/Bitumen | Dirty Petroleum Products | | | 18513 | | | | 2009 | PA | Low | | | 3848284 | 144 | 1257 | 2bb322f03f203bf2570654e6dc22c52e2bb322f03f203bf2570654e6dc22c52e | 2cec64d13c15f4e8999068c63a898335a75bc99b600f97768655ae748b75a2d7 | | Europe | | Rotterdam [NL] | Shell - Rotterdam | Rotterdam [NL] | Netherlands | UK Cont | | | | | |
| 3 | XANTHIA | 9246152 | 17031 | 17829 | General purpose | Laden | Rotterdam [NL] | Vopak Terminal Botlek | Rotterdam [NL] | Netherlands | UK Cont | Amsterdam [NL] | | Amsterdam [NL] | Netherlands | UK Cont | 12 Feb 2023 | 15 Feb 2023 | Diesel/Gasoil | Clean Petroleum Products | Gasoil | | 43370 | | Neda Maritime | | 2003 | NO | Low | | Coated | 8334 | 85 | 1 | 640a7b6ae43683ef52bdc5141b5b11a7640a7b6ae43683ef52bdc5141b5b11a7 | 3a7353f9128d669f31e9d775ef53d9355d34928f1a77801da59576d523cb95c5 | | Europe | Europe | Rotterdam [NL] | Vopak Terminal Botlek | Rotterdam [NL] | Netherlands | UK Cont | Amsterdam [NL] | | Amsterdam [NL] | Netherlands | UK Cont |
| 4 | WOODSIDE REES WITHER | 9810367 | 96000 | 173400 | Conventional | Ballast | Gate LNG Terminal | Gate LNG Terminal | Rotterdam [NL] | Netherlands | UK Cont | | | | | | 01 Feb 2023 | | LNG | Liquefied Natural Gas | Lean | Corpus Christi LNG | 0 | | MARAN GAS MARITIME | | 2019 | GR | Low | | | | 280 | 3967 | 0fa825ab44e6dc5d352db9e8ef47f41e003a794b97b69677ba5f64b2398456e3 | d51d7fc4c74ed04ec69646d297c2f19cd51d7fc4c74ed04ec69646d297c2f19c | | Europe | | Gate LNG Terminal | Gate LNG Terminal | Rotterdam [NL] | Netherlands | UK Cont | | | | | |