From ad9b3fcf326bd165f6b7a2f273c7888f6c40ce72 Mon Sep 17 00:00:00 2001 From: Sam Hughes Date: Tue, 12 Nov 2024 16:00:50 +0000 Subject: [PATCH] docs: update according to product --- vortexasdk/endpoints/freight_pricing_search.py | 5 +++-- vortexasdk/endpoints/freight_pricing_timeseries.py | 6 ++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/vortexasdk/endpoints/freight_pricing_search.py b/vortexasdk/endpoints/freight_pricing_search.py index 6f9898ef..6cad27af 100644 --- a/vortexasdk/endpoints/freight_pricing_search.py +++ b/vortexasdk/endpoints/freight_pricing_search.py @@ -45,10 +45,11 @@ def search( - BLNG routes - `BLNG1g`, `BLNG2g`, `BLNG3g` days: Used to filter results by day on which the record was generated. Must be an ISO date array or not supplied. + Note that BLNG prices are only published on Tuesdays and Fridays. - order: Used to sort the returned results. Must be either 'record_date' or not supplied. + order: Used to sort the returned results. Must be either `record_date` or not supplied. - order_direction: Determines the direction of sorting. ‘asc’ for ascending, ‘desc’ for + order_direction: Determines the direction of sorting. `asc` for ascending, `desc` for descending. size: Used to page results. The size of the result set. Between 0 and 500. diff --git a/vortexasdk/endpoints/freight_pricing_timeseries.py b/vortexasdk/endpoints/freight_pricing_timeseries.py index 63e76ffe..058f9374 100644 --- a/vortexasdk/endpoints/freight_pricing_timeseries.py +++ b/vortexasdk/endpoints/freight_pricing_timeseries.py @@ -39,14 +39,16 @@ def search( time_max: The UTC end date of the time filter. - breakdown_frequency: Must be one of: `'day'`, `'week'`, `'doe_week'`, `'month'`, `'quarter'` or `'year'`. + breakdown_frequency: Must be one of: `day`, `week`, `doe_week`, `month`, `quarter` or `year`. - breakdown_property: Property used to build the value of the aggregation. Must be one of the following: `route`, `cost`, `tce`. + breakdown_property: Property used to build the value of the aggregation. Must be one of the following: + `route`, `cost` (non-LNG routes), `tce` (non-LNG routes). routes: Used to filter by specific routes. Must be one of the following: - Clean routes - `TC1`, `TC2_37`, `TC5`, `TC6`, `TC7`, `TC8`, `TC9`, `TC10`, `TC11`, `TC12`, `TC14`, `TC15`, `TC16`, `TC17`, `TC18`, `TC19`. - Dirty routes - `TD1`, `TD2`, `TD3C`, `TD6`, `TD7`, `TD8`, `TD9`, `TD12`, `TD14`, `TD15`, `TD17`, `TD18`, `TD19`, `TD20`, `TD21`, `TD22`, `TD23`, `TD24`, `TD25`, `TD26`. - BLPG routes - `BLPG1`, `BLPG2`, `BLPG3`. + - BLNG routes - `BLNG1g`, `BLNG2g`, `BLNG3g`. # Returns `TimeSeriesResult`