/
fixtures.py
212 lines (157 loc) · 11.5 KB
/
fixtures.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Ffixtures.ipynb)
"""
from vortexasdk.endpoints.fixtures_result import FixtureResult
from vortexasdk.endpoints.endpoints import FIXTURES
from vortexasdk.operations import Search
from vortexasdk.api.shared_types import to_ISODate
from datetime import datetime
from typing import Any, Dict, List, Union
from vortexasdk.api import ID
from vortexasdk.utils import convert_to_list
class Fixtures(Search):
"""Fixtures Endpoint, use this to search through Vortexa's Fixtures data.
A detailed explanation of the fixtures can be found [here](https://docs.vortexa.com/reference/intro-fixtures).
Limitation
Fixtures are available through the UI, API & SDK only by permission from our shipbroker partner only.
If we limit API access to certain products then you can only pull the fixtures data for said product e.g. CPP only, then they only have access to CPP fixtures.
For an API key to have access to the endpoint, it needs the scopes "v.r.fix" and "v.r.ais".
# What conditions produce a Fixture 'fulfilled' status? - Internal
In terms of the data, we use the laycan and the mapped fixture 'origin'.
Historical movements: The start timestamp of the loading event must be within the 5-day laycan window
(even if the laycan window is less than 5 days, we expand it to 5), or the laycan must be within the start and end
timestamp of the loading event and the fixture's origin hierarchy must agree with the actual loading polygon's
hierarchy.
Future movements: The vessel can be in the reported fixture origin within the laycan window give or take 3 days.
We also compare the predicted destination's hierarchy with the fixture's origin hierarchy.
An agreement (given that the previous feasibility condition is met) is a sufficient condition to create a movement.
When there is disagreement or we don't have a predicted destination, we take into account other factors
(e.g. if the destination is a waypoint, we treat them as agreeing).
# Fixture status
Fixture status indicates the point that the deal has reached in its evolution from "Subs" for vessels on subjects,
to "Fxd" for fixed vessels or sometimes "Failed" or "FLD" for failed fixtures or sometimes "RPLC" for a
replacement fixture or "Conf" for confirmed and "Corr" for corrected.
#### What does the model do in the case of exact duplicates?
- For historical movements, we don't have a particular logic.
- For future movements, we apply our own internal sorting procedure.
#### When we have 2 fixtures that are near exact duplicates but with different freight rates or different charterers, how does the model pick?
- For historical movements, randomly.
- For future movements, we apply our own internal sorting procedure.
"""
_MAX_PAGE_RESULT_SIZE = 500
def __init__(self):
Search.__init__(self, FIXTURES)
def search(
self,
filter_time_field: str = "fixing_timestamp",
filter_time_min: datetime = datetime(2020, 1, 1),
filter_time_max: datetime = datetime(2020, 1, 2),
ids: Union[ID, List[ID]] = None,
filter_charterers: Union[ID, List[ID]] = None,
filter_destinations: Union[ID, List[ID]] = None,
filter_origins: Union[ID, List[ID]] = None,
filter_owners: Union[ID, List[ID]] = None,
filter_effective_controllers: Union[ID, List[ID]] = 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_age_min: int = None,
filter_vessel_age_max: int = None,
filter_vessel_scrubbers: str = "disabled",
filter_vessel_flags: Union[ID, List[ID]] = None,
exclude_origins: Union[ID, List[ID]] = None,
exclude_destinations: Union[ID, List[ID]] = None,
exclude_products: Union[ID, List[ID]] = None,
exclude_vessels: Union[ID, List[ID]] = None,
exclude_vessel_classes: Union[str, List[str]] = None,
exclude_charterers: Union[ID, List[ID]] = None,
exclude_vessel_flags: Union[ID, List[ID]] = None,
order: str = None,
order_direction: str = None,
size: int = None,
) -> FixtureResult:
"""
Find Fixtures matching filters and date range.
# Arguments
filter_time_field: The field that the time range should be filtered against.
filter_time_min: The UTC start date of the time filter.
filter_time_max: The UTC end date of the time filter.
ids: Filter specific fixtures.
filter_charterers: A charterer ID, or list of charterer IDs to filter on.
filter_destinations: A geography ID, or list of geography IDs to filter on.
filter_origins: A geography ID, or list of geography IDs to filter on.
filter_effective_controllers: An effective controller ID, or list of effective controller 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_age_min: A number between 1 and 100 (representing years).
filter_vessel_age_max: A number between 1 and 100 (representing years).
filter_vessel_scrubbers: Either inactive 'disabled', or included 'inc' or excluded 'exc'.
filter_vessel_flags: A vessel flag, or list of vessel flags to filter on.
exclude_origins: A geography ID, or list of geography IDs to exclude.
exclude_destinations: A geography ID, or list of geography IDs to exclude.
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_charterers: A charterer ID, or list of charterer IDs to exclude.
exclude_vessel_flags: A geography ID, or list of geography IDs to exclude.
order: Used to sort the returned results.
order_direction: Determines the direction of sorting.
# Returns
List of Fixtures objects.
# Examples
Find Fixtures from January 2020.
```python
>>> from datetime import datetime
>>> from vortexasdk import Fixtures
>>> df = Fixtures().search(
... filter_time_field="fixing_timestamp",
... filter_time_min=datetime(2020, 1, 1),
... filter_time_max=datetime(2020, 1, 2),
... ).to_df()
```
returns
| vessel.name | tones | origin.label | product.label |
| ------------------------ | ---------------- | ------------ | ------------- |
| ALPINE EAGLE | 454.96048964485 | UK | Crude |
Some values can be NULL: value, stocks, cover, runs. It can happen when:
- The fixture scope is needed to access this endpoint.
"""
exclude_params: Dict[str, Any] = {
"filter_origins": convert_to_list(exclude_origins),
"filter_destinations": convert_to_list(exclude_destinations),
"filter_products": convert_to_list(exclude_products),
"filter_vessels": convert_to_list(exclude_vessels),
"filter_vessel_classes": convert_to_list(exclude_vessel_classes),
"filter_charterers": convert_to_list(exclude_charterers),
"filter_vessel_flags": convert_to_list(exclude_vessel_flags),
}
api_params: Dict[str, Any] = {
filter_time_field: filter_time_field,
"filter_time_min": to_ISODate(filter_time_min),
"filter_time_max": to_ISODate(filter_time_max),
"ids": convert_to_list(ids),
"filter_products": convert_to_list(filter_products),
"filter_charterers": convert_to_list(filter_charterers),
"filter_owners": convert_to_list(filter_owners),
"filter_effective_controllers": convert_to_list(
filter_effective_controllers
),
"filter_vessels": convert_to_list(filter_vessels),
"filter_vessel_classes": convert_to_list(filter_vessel_classes),
"filter_destinations": convert_to_list(filter_destinations),
"filter_origins": convert_to_list(filter_origins),
"filter_vessel_age_min": filter_vessel_age_min,
"filter_vessel_age_max": filter_vessel_age_max,
"filter_vessel_scrubbers": filter_vessel_scrubbers,
"filter_vessel_flags": convert_to_list(filter_vessel_flags),
"order": order,
"order_direction": order_direction,
"exclude": exclude_params,
"size": size if size is not None else self._MAX_PAGE_RESULT_SIZE,
}
response = super().search_with_client(**api_params)
return FixtureResult(
records=response["data"], reference=response["reference"]
)