vortexasdk.endpoints.voyages_congestion_breakdown
Try me out in your browser:
VoyagesCongestionBreakdown
VoyagesCongestionBreakdown(self)
Please note: you will require a subscription to our Freight module to access this endpoint.
search
VoyagesCongestionBreakdown.search(self, breakdown_property: str = 'port', breakdown_size: int = 2000, order: str = None, order_direction: 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, vessels_tags: Union[vortexasdk.api.shared_types.Tag, List[vortexasdk.api.shared_types.Tag]] = None, vessels_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: bool = None, has_charterer: bool = None) -> vortexasdk.endpoints.voyages_congestion_breakdown_result.CongestionBreakdownResult
Returns a count of congested voyages aggregated by congestion location.
Arguments
-
breakdown_size: Number of top records to return.
-
breakdown_property: Property to aggregate upon. Can be one of:
'port'
,'shipping_region'
,'terminal'
. -
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 to filter on.
-
origins_excluded: An origin ID, or list of origin IDs to exclude.
-
destinations: A destination ID, or list of destination IDs to filter on.
-
destinations_excluded: A destination ID, or list of destination IDs 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_cbm_min: A number representing minimum cubic capacity of a vessel.
-
vessel_cbm_max: A number representing maximum cubic capacity tonnage 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'.
-
vessels_tags: A time bound vessel tag, or list of time bound vessel tags to filter on.
-
vessels_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: A boolean to show data where at least one STS transfer occurs.
-
has_charterer: A boolean to show data where at least one charterer is specified.
-
order: Used to sort the returned results. Can be one of:
'location'
,'avg_wait'
,'dwt'
,'capacity'
,'count'
. -
order_direction: Determines the direction of sorting. ‘asc’ for ascending, ‘desc’ for descending.
Returns
CongestionBreakdownResult
Example
Stats for vessels in congestion on 26th April 2022 split by shipping region.
>>> from vortexasdk import VoyagesCongestionBreakdown
>>> from datetime import datetime
>>> search_result = VoyagesCongestionBreakdown().search(
... time_min=datetime(2022, 4, 26),
... time_max=datetime(2022, 4, 26, 23, 59),
... movement_status="congestion",
... breakdown_property="shipping_region",
... breakdown_size=2,
... ).to_df()
Gives the following result:
| | avg_waiting_time | vessel_dwt | vessel_cubic_capacity | vessel_count | cargo_quantity | avg_waiting_time_laden | vessel_dwt_laden | vessel_cubic_capacity_laden | vessel_count_laden | avg_waiting_time_ballast | vessel_dwt_ballast | vessel_cubic_capacity_ballast | vessel_count_ballast | location_details.0.label |
|---:|-------------------:|-------------:|------------------------:|---------------:|-----------------:|-------------------------:|-------------------:|------------------------------:|---------------------:|---------------------------:|---------------------:|--------------------------------:|-----------------------:|:---------------------------|
| 0 | 0 | 9199789 | 10271697 | 353 | 320829 | 0 | 7104725 | 7943428 | 161 | 0 | 2095064 | 2328269 | 192 | East Asia |
| 1 | 0 | 6415240 | 7241430 | 248 | 106209 | 0 | 3392911 | 3815449 | 126 | 0 | 3022329 | 3425981 | 122 | South East Asia |