-
Notifications
You must be signed in to change notification settings - Fork 8
/
vessel_availability_search.py
197 lines (146 loc) · 11 KB
/
vessel_availability_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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Favailability_search.ipynb)
"""
from typing import Any, Dict, List, Union
from vortexasdk.endpoints.vessel_availability_result import (
VesselAvailabilityResult,
)
from vortexasdk.api import ID
from vortexasdk.endpoints.endpoints import VESSEL_AVAILABILITY_SEARCH_RESOURCE
from vortexasdk.logger import get_logger
from vortexasdk.operations import Search
from vortexasdk.utils import convert_to_list
logger = get_logger(__name__)
class VesselAvailabilitySearch(Search):
"""
Vessel Availability Endpoint, use this to search through Vortexa's vessel availability data.
Please note: you will require a subscription to our Freight module to access this endpoint.
"""
_MAX_PAGE_RESULT_SIZE = 500
def __init__(self):
Search.__init__(self, VESSEL_AVAILABILITY_SEARCH_RESOURCE)
def search(
self,
filter_region: str = None,
filter_port: str = None,
use_reference_port: bool = None,
filter_products: Union[ID, List[ID]] = None,
filter_vessels: Union[ID, List[ID]] = None,
filter_vessel_classes: Union[str, List[str]] = None,
filter_vessel_status: str = None,
filter_vessel_location: Union[ID, List[ID]] = None,
filter_owners: Union[ID, List[ID]] = None,
filter_destination: Union[ID, List[ID]] = None,
filter_days_to_arrival: List[Dict[str, int]] = None,
filter_vessel_dwt_min: int = None,
filter_vessel_dwt_max: int = None,
filter_vessel_age_min: int = None,
filter_vessel_age_max: int = None,
filter_vessel_idle_min: int = None,
filter_vessel_idle_max: int = None,
filter_vessel_scrubbers: str = "disabled",
filter_recent_visits: str = None,
exclude_products: Union[ID, List[ID]] = None,
exclude_vessels: Union[ID, List[ID]] = None,
exclude_vessel_classes: Union[str, List[str]] = None,
exclude_vessel_status: str = None,
exclude_vessel_location: Union[ID, List[ID]] = None,
exclude_owners: Union[ID, List[ID]] = None,
exclude_destination: Union[ID, List[ID]] = None,
offset: int = None,
order: str = None,
order_direction: str = None,
) -> VesselAvailabilityResult:
"""
List of vessels that can be available to load a given cargo at a given port on a future date.
# Arguments
order: Used to sort the returned results. Must be one of the following: [‘vessel_status’,
‘days_to_arrival’, ‘days_idle’].
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.
filter_owners: An corporation ID, or list of corporation IDs to filter on.
filter_destination: A geography ID, or list of geography IDs to filter on.
filter_products: A product ID, or list of product IDs to filter on.
filter_vessels: A vessel ID, or list of vessel IDs to filter on.
filter_vessel_classes: A vessel class, or list of vessel classes to filter on.
filter_vessel_status: The vessel status on which to base the filter. Enter 'vessel_status_ballast' for ballast vessels, 'vessel_status_laden_known' for laden vessels with known cargo (i.e. a type of cargo that Vortexa currently tracks) or 'any_activity' for any other vessels
filter_vessel_location: A location ID, or list of location IDs to filter on.
filter_port: Filter by port ID.
filter_region: Filter by region ID - takes precedence over filter_port if provided. This should be used in conjunction with `use_reference_port`
filter_days_to_arrival: Filter availability by time to arrival in days`
use_reference_port: If this flag is enabled, we will return data for
the reference port instead of the user selected one,
filter_vessel_age_min: A number between 1 and 100 (representing years).
filter_vessel_age_max: A number between 1 and 100 (representing years).
filter_vessel_idle_min: A number greater than 0 (representing idle days).
filter_vessel_idle_max: A number greater than 0 and filter_vessel_idle_min (representing idle days).
filter_vessel_dwt_min: A number between 0 and 550000.
filter_vessel_dwt_max: A number between 0 and 550000.
filter_vessel_scrubbers: Either inactive 'disabled', or included 'inc' or excluded 'exc'.
filter_recent_visits: Filter availability by each vessel's recent visits
exclude_products: A product ID, or list of product IDs to exclude.
exclude_vessels: A vessel ID, or list of vessel IDs to exclude.
exclude_vessel_classes: A vessel class, or list of vessel classes to exclude.
exclude_vessel_status: The vessel status on which to base the filter. Enter 'vessel_status_ballast' for ballast vessels, 'vessel_status_laden_known' for laden vessels with known cargo (i.e. a type of cargo that Vortexa currently tracks) or 'any_activity' for any other vessels
exclude_owners: An owner ID, or list of owner IDs to exclude.
exclude_vessel_location: A location ID, or list of location IDs to filter on.
exclude_destination: A location ID, or list of location IDs to filter on.
# Returns
`VesselAvailabilityResult`
# Example
Top 2 available vessels arriving at Rotterdam port in the next 5 days.
```python
>>> from vortexasdk import VesselAvailabilitySearch, Geographies
>>> rotterdam = "68faf65af1345067f11dc6723b8da32f00e304a6f33c000118fccd81947deb4e"
>>> df = VesselAvailabilitySearch().search(
... filter_port=rotterdam,
... filter_days_to_arrival={"min": 1, "max": 5}
... ).to_df(columns=['available_at','vessel_name','vessel_class']).head(2)
```
| | available_at | vessel_name | vessel_class |
|---:|:-------------------------|:-------------------------|-------------:|
| 0 | 2017-09-30 15:30:27+00:00| STAR RIVER | handysize |
| 1 | 2017-08-29 14:51:32+00:00| AMALTHEA | aframax |
"""
exclude_params: Dict[str, Any] = {
"filter_destination": convert_to_list(exclude_destination),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_owners": convert_to_list(exclude_owners),
"filter_vessel_status": convert_to_list(exclude_vessel_status),
"filter_vessel_location": convert_to_list(exclude_vessel_location),
}
api_params: Dict[str, Any] = {
"filter_products": convert_to_list(filter_products),
"filter_vessels": convert_to_list(filter_vessels),
"filter_vessel_classes": convert_to_list(filter_vessel_classes),
"filter_vessel_status": filter_vessel_status,
"filter_vessel_location": convert_to_list(filter_vessel_location),
"filter_owners": convert_to_list(filter_owners),
"filter_destination": convert_to_list(filter_destination),
"filter_region": filter_region,
"filter_port": filter_port,
"use_reference_port": use_reference_port,
"filter_days_to_arrival": convert_to_list(filter_days_to_arrival),
"filter_vessel_dwt_min": filter_vessel_dwt_min,
"filter_vessel_dwt_max": filter_vessel_dwt_max,
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_idle_min": filter_vessel_idle_min,
"filter_vessel_idle_max": filter_vessel_idle_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_recent_visits": filter_recent_visits,
"exclude": exclude_params,
"offset": offset,
"order": order,
"order_direction": order_direction,
"size": self._MAX_PAGE_RESULT_SIZE,
}
response = super().search_with_client(**api_params)
return VesselAvailabilityResult(
records=response["data"], reference=response["reference"]
)