From 99aa96fd1cbac5ba6ccb857eaab917d08da1447d Mon Sep 17 00:00:00 2001 From: Jack Burgess Date: Mon, 29 Jun 2026 15:36:44 +0100 Subject: [PATCH 1/4] chore: conflict --- ...ere_freight_pricing_forecast_explanation.py | 14 +++++--------- ...here_freight_pricing_forecast_timeseries.py | 7 ++++--- ...ywhere_freight_pricing_get_price_details.py | 10 ++++++++-- ...where_freight_pricing_post_price_details.py | 10 ++++++++-- ...nywhere_freight_pricing_price_timeseries.py | 10 +++++++--- ...re_freight_pricing_top_ports_destination.py | 18 ++++++++++++++---- ...nywhere_freight_pricing_top_ports_origin.py | 18 ++++++++++++++---- ...e_freight_pricing_vessel_classes_details.py | 10 ++++++---- 8 files changed, 66 insertions(+), 31 deletions(-) diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py b/vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py index 538a42fe..16b82710 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py @@ -32,8 +32,9 @@ class AnywhereFreightPricingForecastExplanation: """ Anywhere Freight Pricing Forecast Explanation endpoint. - Explains forecast price movements for a route by providing a base date - and a list of explanations for upcoming time periods. + Given a route (origin, destination, vessel class, product), this returns + a base date and a list of forecast explanations for upcoming dates at + the given frequency. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -50,13 +51,13 @@ def search( product: AfpProduct, frequency: AfpExplanationFrequency = "month_fixed", avoid_zone: Optional[List[AfpAvoidZone]] = None, - include_port_costs: Optional[bool] = None, ) -> AnywhereFreightPricingResult: """ Get forecast price movement explanations for a route. Given a route (origin, destination, vessel class, product), this returns - a base date and a list of forecast explanations for upcoming time periods. + a base date and a list of forecast explanations for upcoming dates at + the given frequency. # Arguments @@ -79,8 +80,6 @@ def search( avoid_zone: Routing zones to avoid for this route. Options: `'Panama Canal'`, `'Suez Canal'`. - include_port_costs: Whether to include port costs in the calculation. - # Returns `AnywhereFreightPricingResult` @@ -129,9 +128,6 @@ def search( if avoid_zone is not None: params["avoid_zone"] = avoid_zone - if include_port_costs is not None: - params["include_port_costs"] = str(include_port_costs).lower() - client = default_client() url = client._create_url_with_params( self._resource, params, doseq=True diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py b/vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py index 6bdd5ca3..0bcb7c4e 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py @@ -46,9 +46,10 @@ def search( """ Get forecast pricing over time for multiple routes. - Given a set of details about multiple routes (origin, destination, etc), - a time period and frequency, this returns forecast pricing over time - bucketed by the chosen frequency. + Given a set of routes, a frequency, unit and a time period, this endpoint + returns forecast-only prices, lumpsums and upper and lower bounds bucketed + by the requested frequency per route. Price is the total cost including + voyage, port and canal costs. Lumpsum is the total voyage cost in USD. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py b/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py index 29ac42fa..9d94943a 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py @@ -31,7 +31,10 @@ class AnywhereFreightPricingGetPriceDetails: 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. + this will find rates, lumpsums and prediction confidences of the route. + Rates represent the per-unit price (voyage + port + canal costs). + Lumpsums are the total voyage cost in USD. + The confidence returns the confidence of these estimations. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -56,7 +59,10 @@ def search( 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. + this will find rates, lumpsums and prediction confidences of the route. + Rates represent the per-unit price (voyage + port + canal costs). + Lumpsums are the total voyage cost in USD. + The confidence returns the confidence of these estimations. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py b/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py index 37f5daf0..c8bcc23b 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py @@ -28,7 +28,10 @@ class AnywhereFreightPricingPostPriceDetails(Search): Anywhere Freight Pricing Post Price Details endpoint. Given a set of details about multiple routes (origin, destination, etc), - this will find rates, lumpsums and prediction confidence for each route. + this will find rates, lumpsums and prediction confidences of each of the routes. + Rates represent the per-unit price (voyage + port + canal costs). + Lumpsums are the total voyage cost in USD. + The confidence returns the confidence of these value estimations. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -48,7 +51,10 @@ def search( List prices for multiple routes. Given a set of details about multiple routes (origin, destination, etc), - this will find rates, lumpsums and prediction confidence for each route. + this will find rates, lumpsums and prediction confidences of each of the routes. + Rates represent the per-unit price (voyage + port + canal costs). + Lumpsums are the total voyage cost in USD. + The confidence returns the confidence of these value estimations. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py b/vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py index 40b14ce5..9a3636de 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py @@ -46,9 +46,13 @@ def search( """ Get historical pricing over time for multiple routes. - Given a set of details about multiple routes (origin, destination, etc), - a time period and frequency, this returns historical pricing over time - bucketed by the chosen frequency. + Given a set of details about multiple routes (origin, destination, product + and vessel class), a time period, unit and a frequency, this returns + historical pricing and voyage pricing over time per route bucketed by the + chosen frequency. Price is defined as the overall cost including voyage cost, + port costs and canal costs where applicable, given in the selected unit. + Voyage price is the price of just the voyage, given in the selected unit. + Lumpsum is the overall cost total of the voyage. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py index 83164ebf..e8f0acd8 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py @@ -28,8 +28,13 @@ class AnywhereFreightPricingTopPortsDestination: """ Anywhere Freight Pricing Top Ports Destination endpoint. - List top destination ports. A top destination port refers to the port - with the greatest volume of incoming voyages from vessels in a specified class. + Fetches the top destination ports for a given origin with a specified class. + These are the top ten ports with the greatest count of laden voyages from + vessels of the specified class departing the given origin. + Rates returns the voyage costs as well as a breakdown of additional costs + in the given unit. Lumpsum returns the total voyage cost as well as a + breakdown of additional costs as a total cost. + The confidence returns the confidence of these estimations. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -49,8 +54,13 @@ def search( """ List top destination ports from a given origin. - A top destination port refers to the port with the greatest volume of - incoming voyages from vessels in a specified class. + Fetches the top destination ports for a given origin with a specified class. + These are the top ten ports with the greatest count of laden voyages from + vessels of the specified class departing the given origin. + Rates returns the voyage costs as well as a breakdown of additional costs + in the given unit. Lumpsum returns the total voyage cost as well as a + breakdown of additional costs as a total cost. + The confidence returns the confidence of these estimations. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py index 51ef66c5..3131a216 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py @@ -28,8 +28,13 @@ class AnywhereFreightPricingTopPortsOrigin: """ Anywhere Freight Pricing Top Ports Origin endpoint. - List top origin ports. A top origin port refers to the port - with the greatest volume of outgoing voyages from vessels in a specified class. + 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 returns the voyage costs as well as a breakdown of additional costs + in the given unit. Lumpsum returns the total voyage cost as well as a + breakdown of additional costs as a total cost. + The confidence returns the confidence of these estimations. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -49,8 +54,13 @@ def search( """ List top origin ports for a given destination. - A top origin port refers to the port with the greatest volume of - outgoing voyages from vessels in a specified class. + 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 returns the voyage costs as well as a breakdown of additional costs + in the given unit. Lumpsum returns the total voyage cost as well as a + breakdown of additional costs as a total cost. + The confidence returns the confidence of these estimations. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py b/vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py index 947a37ca..b949cccf 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py @@ -20,8 +20,9 @@ class AnywhereFreightPricingVesselClassesDetails: """ Anywhere Freight Pricing Vessel Classes Details endpoint. - Lists all the vessel classes supported for Anywhere Freight Pricing - and the tonnages they can carry. + Returns the list of vessel classes supported in Anywhere Freight Pricing, + along with their suggested default tonnage and minimum and maximum + supported tonnages. Please note, a subscription to our Anywhere Freight Pricing module is required to access Anywhere Freight Pricing. @@ -34,8 +35,9 @@ def search(self) -> AnywhereFreightPricingResult: """ List vessel classes with tonnages. - Lists all the vessel classes supported for Anywhere Freight Pricing - and the tonnages they can carry. + Returns the list of vessel classes supported in Anywhere Freight Pricing, + along with their suggested default tonnage and minimum and maximum + supported tonnages. # Returns `AnywhereFreightPricingResult` From 9add0c404afd80c477a2de0c871ef8dc5ed2ba21 Mon Sep 17 00:00:00 2001 From: Jack Burgess Date: Mon, 29 Jun 2026 15:47:06 +0100 Subject: [PATCH 2/4] feat: small text updates --- ...anywhere_freight_pricing_top_ports_destination.py | 12 ++++++------ .../anywhere_freight_pricing_top_ports_origin.py | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py index e8f0acd8..0f21c346 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py @@ -31,10 +31,10 @@ class AnywhereFreightPricingTopPortsDestination: Fetches the top destination ports for a given origin with a specified class. These are the top ten ports with the greatest count of laden voyages from vessels of the specified class departing the given origin. - Rates returns the voyage costs as well as a breakdown of additional costs - in the given unit. Lumpsum returns the total voyage cost as well as a + 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 returns the confidence of these estimations. + 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. @@ -57,10 +57,10 @@ def search( Fetches the top destination ports for a given origin with a specified class. These are the top ten ports with the greatest count of laden voyages from vessels of the specified class departing the given origin. - Rates returns the voyage costs as well as a breakdown of additional costs - in the given unit. Lumpsum returns the total voyage cost as well as a + 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 returns the confidence of these estimations. + The confidence score indicates the confidence of these estimates. # Arguments diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py index 3131a216..f831b3b4 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py @@ -31,10 +31,10 @@ class AnywhereFreightPricingTopPortsOrigin: 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 returns the voyage costs as well as a breakdown of additional costs - in the given unit. Lumpsum returns the total voyage cost as well as a + 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 returns the confidence of these estimations. + 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. @@ -57,10 +57,10 @@ def search( 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 returns the voyage costs as well as a breakdown of additional costs - in the given unit. Lumpsum returns the total voyage cost as well as a + 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 returns the confidence of these estimations. + The confidence score indicates the confidence of these estimates. # Arguments From d28d8e3819316da6bbb9e4c47fe0c3ad765075ee Mon Sep 17 00:00:00 2001 From: Jack Burgess Date: Mon, 29 Jun 2026 17:33:08 +0100 Subject: [PATCH 3/4] feat: small text updates --- ...anywhere_freight_pricing_forecast_explanation.py | 13 ------------- .../anywhere_freight_pricing_get_price_details.py | 4 ++-- .../anywhere_freight_pricing_post_price_details.py | 4 ++-- 3 files changed, 4 insertions(+), 17 deletions(-) diff --git a/tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py b/tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py index afc26510..87632011 100644 --- a/tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py +++ b/tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py @@ -57,16 +57,3 @@ def test_search_with_avoid_zone(self): result_list = result.to_list() assert len(result_list) > 0 - - def test_search_with_include_port_costs(self): - result = AnywhereFreightPricingForecastExplanation().search( - origin="68faf65af1345067f11dc6723b8da32f00e304a6f33c000118fccd81947deb4e", - destination="ea4921c8ad4fddb5fe3e7a4f834c1aa5863e43283c73da5f02d93bbc5dba72eb", - vessel_class="oil_handymax_mr2", - product="clean", - frequency="month", - include_port_costs=True, - ) - - result_list = result.to_list() - assert len(result_list) > 0 diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py b/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py index 9d94943a..656c4442 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py @@ -56,10 +56,10 @@ def search( suggested_tonnage: Optional[float] = None, ) -> AnywhereFreightPricingResult: """ - List prices of a route. + List historical prices of a route. Given a set of details about a single route (origin, destination, etc), - this will find rates, lumpsums and prediction confidences of the route. + this will find historical rates, lumpsums and prediction confidences of the route. Rates represent the per-unit price (voyage + port + canal costs). Lumpsums are the total voyage cost in USD. The confidence returns the confidence of these estimations. diff --git a/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py b/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py index c8bcc23b..db00d30b 100644 --- a/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py +++ b/vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py @@ -48,10 +48,10 @@ def search( unit: AfpUnit = "usd_per_tonne", ) -> AnywhereFreightPricingResult: """ - List prices for multiple routes. + List historical prices for multiple routes. Given a set of details about multiple routes (origin, destination, etc), - this will find rates, lumpsums and prediction confidences of each of the routes. + this will find historical rates, lumpsums and prediction confidences of each of the routes. Rates represent the per-unit price (voyage + port + canal costs). Lumpsums are the total voyage cost in USD. The confidence returns the confidence of these value estimations. From 7154e420d2f42d398c45904027af97d9b874a5f5 Mon Sep 17 00:00:00 2001 From: Jack Burgess Date: Tue, 30 Jun 2026 09:09:48 +0100 Subject: [PATCH 4/4] chore: vb --- vortexasdk/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vortexasdk/version.py b/vortexasdk/version.py index 65d99ece..94650f2d 100644 --- a/vortexasdk/version.py +++ b/vortexasdk/version.py @@ -1 +1 @@ -__version__ = "1.0.27" +__version__ = "1.0.28"