vortexasdk.endpoints.canal_transit

Try me out in your browser:

Binder

CanalTransit

CanalTransit(self)

Canal Transit Endpoint, use this to search through Vortexa's canal transit records.

A detailed explanation of what Canal Transit is can be found here.

search

CanalTransit.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, 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.canal_transit_result.CanalTransitResult

Find CanalTransitRecords matching the given search parameters.

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_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'],

  • 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. 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 record update time,

  • 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

CanalTransitResults, containing all the canal transit records matching the given search terms.

vortexasdk.endpoints.canal_transit_result

CanalTransitResult

CanalTransitResult(__pydantic_self__, **data: Any) -> None

Container class holdings search results returns from the Canal transit endpoint.

This class has two methods, to_list(), and to_df(), allowing search results to be represented as a list of CanalTransitRecords, or as a pd.DataFrame , respectively.

to_list

CanalTransitResult.to_list(self) -> List[vortexasdk.api.canal_transit.CanalTransitRecord]

Represent canal transit records as a list of CanalTransitRecords.

to_df

CanalTransitResult.to_df(self, columns=['vessel_id', 'vessel_name', 'vessel_imo', 'vessel_class.0.label', 'vessel_cubic_capacity', 'vessel_dead_weight', 'booked', 'canal', 'direction', 'lock', 'queue_arrival_time', 'canal_entry_time', 'cargoes.0.product.label', 'cargoes.0.quantity_barrels', 'cargoes.0.quantity_tonnes', 'cargoes.0.quantity_cubic_metres', 'origin.0.label', 'destination.0.label']) -> pandas.core.frame.DataFrame

Represent canal transit record as a pd.DataFrame.

Arguments

  • columns: Output columns present in the pd.DataFrame. Enter columns='all' to return all available columns. Enter columns=None to use canal_transit.DEFAULT_COLUMNS.

Returns

pd.DataFrame, one row per canal transit record.