-
Notifications
You must be signed in to change notification settings - Fork 8
/
freight_pricing_search.py
96 lines (70 loc) · 5.68 KB
/
freight_pricing_search.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Ffreight_pricing_search.ipynb)
"""
from datetime import datetime
from typing import Any, Dict, List, Union
from vortexasdk.api.shared_types import to_ISODate_Array
from vortexasdk.endpoints.freight_pricing_result import FreightPricingResult
from vortexasdk.endpoints.endpoints import FREIGHT_PRICING_SEARCH
from vortexasdk.logger import get_logger
from vortexasdk.operations import Search
from vortexasdk.utils import convert_to_list
logger = get_logger(__name__)
class FreightPricingSearch(Search):
"""
Freight Pricing Endpoint, use this to search through Vortexa's Baltic Exchange pricing data.
"""
_MAX_PAGE_RESULT_SIZE = 500
def __init__(self):
Search.__init__(self, FREIGHT_PRICING_SEARCH)
def search(
self,
routes: Union[List[str], str] = None,
days: List[datetime] = [],
offset: int = None,
order: str = None,
order_direction: str = None,
) -> FreightPricingResult:
"""
List of pricing information applicable for a specified route on a given day.
# Arguments
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`.
days: Used to filter results by day on which the record was generated. Must be an ISO date array 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
descending.
offset: Used to page results. The offset from which records should be returned.
size: Used to page results. The size of the result set. Between 0 and 500.
# Returns
`FreightPricingResult`
# Example
WS rate for the TD3C route generated on 15th Nov 2021.
```python
>>> from vortexasdk import FreightPricingSearch
>>> from datetime import datetime
>>> day = [datetime(2021, 11, 15)]
>>> df = FreightPricingSearch().search(
... routes=['TD3C'],
... days=day
... ).to_df(columns=['short_code','rate','rate_unit'])
```
| | short_code | rate | rate_unit |
|---:|:-----------|:------|----------:|
| 0 | TD3C | 43.32 | WS |
"""
api_params: Dict[str, Any] = {
"routes": convert_to_list(routes),
"days": convert_to_list(to_ISODate_Array(days)),
"offset": offset,
"order": order,
"order_direction": order_direction,
"size": self._MAX_PAGE_RESULT_SIZE,
}
response = super().search_with_client(**api_params)
return FreightPricingResult(
records=response["data"], reference=response["reference"]
)