vortexasdk.endpoints.anywhere_freight_pricing_top_ports_origin

Try me out in your browser:

AnywhereFreightPricingTopPortsOrigin

AnywhereFreightPricingTopPortsOrigin(self)

Anywhere Freight Pricing Top Ports Origin endpoint.

Fetches the top origin ports for a given destination with a specified class. These are the top ten ports with the greatest count of laden voyages to the given destination from vessels with the specified class. Rates return the voyage costs as well as a breakdown of additional costs in the given unit. Lumpsum return the total voyage cost as well as a breakdown of additional costs as a total cost. The confidence score indicates the confidence of these estimates.

Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing.

search

AnywhereFreightPricingTopPortsOrigin.search(
    destination: str,
    vessel_class:
    typing_extensions.Literal['oil_coastal', 'oil_specialised', 'oil_handysize_mr1', 'oil_handymax_mr2', 'oil_panamax_lr1', 'oil_aframax_lr2', 'oil_suezmax_lr3', 'oil_vlcc'],
    product: typing_extensions.Literal['clean', 'dirty', 'crude'],
    unit:
    typing_extensions.Literal['usd_per_tonne', 'usd_per_barrel'] = 'usd_per_tonne',
    avoid_zone:
    typing.Optional[typing.List[typing_extensions.Literal['Panama Canal', 'Suez Canal']]] = None
)

List top origin ports for a given destination.

Fetches the top origin ports for a given destination with a specified class. These are the top ten ports with the greatest count of laden voyages to the given destination from vessels with the specified class. Rates return the voyage costs as well as a breakdown of additional costs in the given unit. Lumpsum return the total voyage cost as well as a breakdown of additional costs as a total cost. The confidence score indicates the confidence of these estimates.

Arguments

destination: Geographical ID of the destination port.

vessel_class: The vessel class for the route. Must be one of:
    `'oil_coastal'`, `'oil_specialised'`, `'oil_handysize_mr1'`,
    `'oil_handymax_mr2'`, `'oil_panamax_lr1'`, `'oil_aframax_lr2'`,
    `'oil_suezmax_lr3'`, `'oil_vlcc'`.

product: The product type. Must be one of: `'clean'`, `'dirty'`, `'crude'`.

unit: The unit for pricing. Must be one of: `'usd_per_tonne'`, `'usd_per_barrel'`.
    Defaults to `'usd_per_tonne'`.

avoid_zone: Routing zones to avoid. Options: `'Panama Canal'`, `'Suez Canal'`.

Returns

AnywhereFreightPricingResult

Example

Get top origin ports for clean products to Rotterdam using MR2 vessels.

>>> from vortexasdk import AnywhereFreightPricingTopPortsOrigin
>>> result = AnywhereFreightPricingTopPortsOrigin().search(
...     destination="68faf65af1345067f11dc6723b8da32f00e304a6f33c000118fccd81947deb4e",
...     vessel_class="oil_handymax_mr2",
...     product="clean",
...     unit="usd_per_tonne",
... )
>>> df = result.to_df()

Returns a DataFrame with columns including geography info, rates, lumpsums, and confidence values:

	geography_name	date	rate	lumpsum	confidence
0	Houston [US]	2024-01-01	63.55	2351511.83	2