vortexasdk.endpoints.anywhere_freight_pricing_get_price_details

Try me out in your browser:

AnywhereFreightPricingGetPriceDetails

AnywhereFreightPricingGetPriceDetails(self)

Anywhere Freight Pricing Get Price Details endpoint.

Given a set of details about a single route (origin, destination, etc), this will find rates, lumpsums and prediction confidence of the route.

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

search

AnywhereFreightPricingGetPriceDetails.search(
  time_min: datetime,
  time_max: datetime,
  origin_port: str,
  destination_port: 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,
  suggested_tonnage: typing.Optional[float] = None)

List prices of a route.

Given a set of details about a single route (origin, destination, etc), this will find rates, lumpsums and prediction confidence of the route.

Arguments

time_min: The UTC start date of the time filter.

time_max: The UTC end date of the time filter.

origin_port: Geographic ID of the origin port.

destination_port: Geographic 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 for this route. Options:
    `'Panama Canal'`, `'Suez Canal'`.

suggested_tonnage: Override the default suggested tonnage Vortexa will
    suggest based on the vessel class.

Returns

AnywhereFreightPricingResult

Example

Get price details for an Aframax LR2 crude route from Houston to Rotterdam.

>>> from vortexasdk import AnywhereFreightPricingGetPriceDetails
>>> from datetime import datetime
>>> result = AnywhereFreightPricingGetPriceDetails().search(
...     time_min=datetime(2024, 1, 1),
...     time_max=datetime(2024, 12, 31),
...     origin_port="7f314ba0a498c36359b1c88781e94a73e19dcc9bbb030ec6b82f944a73d4da2f",
...     destination_port="68faf65af1345067f11dc6723b8da32f00e304a6f33c000118fccd81947deb4e",
...     vessel_class="oil_aframax_lr2",
...     product="crude",
...     unit="usd_per_tonne",
... )
>>> df = result.to_df()

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

	date	rate	lumpsum	confidence
0	2024-01-01	12.50	1250000.0	2
1	2024-01-02	12.75	1275000.0	2