vortexasdk.endpoints.canal_transit_timeseries

Try me out in your browser:

Binder

CanalTransitTimeseries

CanalTransitTimeseries(self)

search

CanalTransitTimeseries.search(self, filter_vessel_cubic_capacity_min: Union[int, NoneType] = None, filter_vessel_cubic_capacity_max: Union[int, NoneType] = None, filter_vessel_dead_weight_min: Union[int, NoneType] = None, filter_vessel_dead_weight_max: Union[int, NoneType] = None, filter_vessel_classes: Union[str, List[str], NoneType] = None, filter_vessels: Union[str, List[str], NoneType] = None, filter_products: Union[str, List[str], NoneType] = None, filter_origin: Union[str, List[str], NoneType] = None, filter_destination: Union[str, List[str], NoneType] = None, filter_charterer: Union[str, List[str], NoneType] = None, filter_effective_controller: Union[str, List[str], NoneType] = None, filter_queue_arrival_time_min: Union[datetime.datetime, NoneType] = None, filter_queue_arrival_time_max: Union[datetime.datetime, NoneType] = None, filter_canal_entry_time_min: Union[datetime.datetime, NoneType] = None, filter_canal_entry_time_max: Union[datetime.datetime, NoneType] = None, filter_canal_exit_time_min: Union[datetime.datetime, NoneType] = None, filter_canal_exit_time_max: Union[datetime.datetime, NoneType] = None, filter_booked_time_min: Union[datetime.datetime, NoneType] = None, filter_booked_time_max: Union[datetime.datetime, NoneType] = None, filter_booked_status: Union[bool, NoneType] = None, filter_voyage_status: Union[str, NoneType] = None, updated_since: Union[datetime.datetime, NoneType] = None, filter_canal: Union[str, NoneType] = None, filter_direction: Union[str, NoneType] = None, filter_lock: Union[str, NoneType] = None, time_min: datetime.datetime = datetime.datetime(2024, 7, 1, 13, 16, 32, 255466), time_max: datetime.datetime = datetime.datetime(2024, 7, 5, 13, 16, 32, 255478), timeseries_activity: str = 'started_waiting', metric: str = 'count_of_vessels', timeseries_frequency: str = 'day', exclude_filter_vessels: Union[str, List[str], NoneType] = None, exclude_filter_vessel_classes: Union[str, List[str], NoneType] = None, exclude_filter_products: Union[str, List[str], NoneType] = None, exclude_filter_origin: Union[str, List[str], NoneType] = None, exclude_filter_destination: Union[str, List[str], NoneType] = None, exclude_filter_charterer: Union[str, List[str], NoneType] = None, exclude_filter_effective_controller: Union[str, List[str], NoneType] = None) -> vortexasdk.endpoints.timeseries_result.TimeSeriesResult

Aggregate Canal Transit records for various activities and frequencies.

Arguments

  • filter_vessel_cubic_capacity_min: Minimum cubic capacity of the vessel,

  • filter_vessel_cubic_capacity_max: Maximum cubic capacity of the vessel,

  • filter_vessel_dead_weight_min: Minimum DWT of the vessel,

  • filter_vessel_dead_weight_max: Maximum DWT of the vessel,

  • filter_vessel_classes: A vessel class, or list of vessel classes to filter on.

  • filter_vessels: A vessel ID, or list of vessel IDs to filter on.

  • filter_products: A product ID, or list of product IDs to filter on.

  • filter_origin: A geography ID, or list of geography IDs to filter on.

  • filter_destination: A geography ID, or list of geography IDs to filter on.

  • filter_charterer: An charterer ID, or list of charterer IDs to filter on.

  • filter_effective_controllers: An effective controller ID, or list of effective controller IDs to filter on.

  • filter_queue_arrival_time_min: The UTC date of when vessel arrived to the queue,

  • filter_queue_arrival_time_max: The UTC date of when vessel arrived to the queue,

  • filter_canal_entry_time_min: The UTC date of when vessel entered the canal,

  • filter_canal_entry_time_max: The UTC date of when vessel entered the canal,

  • filter_canal_exit_time_min: The UTC date of when vessel left the canal,

  • filter_canal_exit_time_max: The UTC date of when vessel left the canal,

  • filter_booked_time_min: The UTC date of planned time to enter the canal,

  • filter_booked_time_max: The UTC date of planned time to enter the canal,

  • filter_booked_status: Boolean to filter vessels that booked their slots before arrival. Can be 'true' or 'false',

  • filter_voyage_status: A voyage status, or list of voyage statuses to filter on. Can be one of: 'ballast', 'laden',

  • updated_since: The UTC date of last update time of the record,

  • filter_canal: Canal the vessel is queuing for. Must be one of ['suez_canal', 'panama_canal'],

  • filter_direction: Direction that vessel is heading. Must be one of ['northbound', 'southbound'],

  • filter_lock: Route taken through the canal. For the Panama canal, it must be one of ['panamax', 'neopanamax'],

  • time_min: The UTC date when timeseries_activity starts,

  • time_max: The UTC date when timeseries_activity ends,

  • timeseries_activity: Activity of the vessel we want to aggregate on. Must be one of ['started_waiting', 'waiting', 'started_transiting', 'transiting', 'transited']

  • metric: Aggregation metric. Must be one of ['count_of_vessels', 'minimum_waiting_time', 'maximum_waiting_time', 'average_waiting_time']

  • timeseries_frequency: Frequency denoting the granularity of the time series. Must be one of ['day', 'week']

  • exclude_filter_vessels: A vessel ID, or list of vessel IDs to exclude,

  • exclude_filter_vessel_classes: A vessel class, or list of vessel classes to exclude,

  • exclude_filter_products: A product ID, or list of product IDs to exclude,

  • exclude_filter_origin: A geography ID, or list of geography IDs to exclude,

  • exclude_filter_destination: A geography ID, or list of geography IDs to exclude,

  • exclude_filter_charterer: A charterer ID, or list of charterer IDs to exclude,

  • exclude_filter_effective_controller: A effective controller ID, or list of IDs to exclude,

Returns

CanalTransitTimeseries