/
onshore_inventories_search.py
169 lines (143 loc) · 9.65 KB
/
onshore_inventories_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
"""
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 datetime import datetime
from typing import Any, Dict, List, Union
from vortexasdk.endpoints.onshore_inventories_result import (
OnshoreInventoriesResult,
)
from vortexasdk.api.shared_types import to_ISODate
from vortexasdk.api import ID
from vortexasdk.endpoints.endpoints import CRUDE_ONSHORE_INVENTORIES_SEARCH
from vortexasdk.logger import get_logger
from vortexasdk.operations import Search
from vortexasdk.utils import convert_to_list
logger = get_logger(__name__)
class OnshoreInventoriesSearch(Search):
"""
Crude Onshore Inventories Endpoint, use this to search through Vortexa's Onshore Inventory data.
Please note: you will require a subscription to our Crude Onshore Inventories module to access this endpoint.
"""
_MAX_PAGE_RESULT_SIZE = 500
def __init__(self):
Search.__init__(self, CRUDE_ONSHORE_INVENTORIES_SEARCH)
def search(
self,
asset_tank_ids: Union[ID, List[ID]] = None,
corporate_entity_ids: Union[ID, List[ID]] = None,
crude_confidence: List[str] = None,
location_ids: Union[ID, List[ID]] = None,
measurement_ids: Union[ID, List[ID]] = None,
offset: int = None,
order: str = None,
order_direction: str = None,
size: int = None,
storage_types: List[str] = None,
time_min: datetime = None,
time_max: datetime = None,
) -> OnshoreInventoriesResult:
"""
List of crude onshore inventories across the globe.
# Arguments
asset_tank_ids: An array of tank IDs to filter on.
corporate_entity_ids: An array of owner ID(s) to filter on.
crude_confidence: An array of confidence metrics to filter on. Possible values are: `'confirmed'`, `'probable'`, `'unlikely'`
location_ids: An array of geography ID(s) to filter on.
measurement_ids: An array of unique measurements (each COI measurement) to filter on.
offset: Used to page results. The offset from which records should be returned.
order: Used to sort the returned results. Can be one of:`'measurement_id'`, `'tank_id'`.
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.
storage_types: An array of storage types to filter on. Possible values are: `'refinery'`, `'commercial'`, `'spr'`.
time_min: The UTC start date of the time filter.
time_max: The UTC end date of the time filter.
# Returns
`OnshoreInventoriesResult`
# Data frame example
Top 5 Crude Onshore Inventories where 'crude_confidence' status is 'confirmed'.
```python
>>> from vortexasdk import OnshoreInventoriesSearch
>>> df = OnshoreInventoriesSearch().search(crude_confidence=['confirmed']).to_df().head(5)
```
| | measurement_id | tank_id | tank_details.capacity_bbl | ... | fill_bbl | fill_tons | fill_cbm |
|---:|:--------------------------|:--------------------------|--------------------------:|-----|----------|--------------|--------------|
| 0 | 1e41bdfc8fa21a1f3d874d41a | af83f5475ebd45b9167254667 | 225055 | ... | 194898 | 26648.208642 | 30986.443224 |
| 1 | 211d96e43ff6893d555f8e7e0 | f7c583b26ff8d4e50d4ba9da5 | 658327 | ... | 131804 | 18021.429116 | 20955.254352 |
| 2 | 5ef5595cadf0161f6b59a0769 | 7047360864070b7a08802ae82 | 209196 | ... | 468790 | 64097.187910 | 74531.984520 |
| 3 | b70f105d6309fb1acdb4b18c5 | 2ae82a3b79f32105716725460 | 664169 | ... | 105934 | 14484.249886 | 16842.234792 |
| 4 | 72841f54183a082de91d9er43 | 802ae82a3b79f321167254667 | 75669 | ... | 474814 | 64920.843406 | 75489.728232 |
# List example
First COI object in the list where 'crude_confidence' status is 'confirmed'.
```python
>>> from vortexasdk import OnshoreInventoriesSearch
>>> list = OnshoreInventoriesSearch().search(crude_confidence='confirmed').to_list()[0]
```
```
{
measurement_id: '5731385e7b0ce8',
tank_id: 'c5a6bf5e95e969cf7',
tank_details: {
id: 'c5a6bf5e95e969cf7',
capacity_bbl: 875573,
capacity_cbm: 139205,
capacity_ton: 119716,
corporate_entity_details: {
id: 'b25523ae823b9e38bb11a161eb60d42194f1a886e58dfe39592dcc324f06f60e',
label: 'Repsol'
},
corporate_entity_id: 'b25523ae823b9e38bb11a161eb60d42194f1a886e58dfe39592dcc324f06f60e',
crude_confidence: 'confirmed',
last_updated: '2021-08-03T14: 34: 18.533Z',
leaf: True,
location_id: 'a98c21d06633d86c8c55',
location_details: [
{
id: 'a98c21d06633d86c8c55',
label: 'CartagenaLNGTerminal(Enagas)',
layer: 'terminal'
},
{
id: 'c7baa1cfb2a11e7c2eca',
label: 'Cartagena[
ES
]',
layer: 'port'
}
],
name: 'CGA030',
pos: (-0.926539,
37.574),
radius: 45,
ref_type: 'asset_tank',
storage_terminal_id: 'e757382d4aa5a8aa77d0f11ac7f535fb32993bae89bdf581771f155d1c0149b8',
storage_terminal_name: 'RepsolCartagenaRefinery',
storage_type: 'refinery'
},
measurement_timestamp: '2021-09-06T17: 50: 12',
publish_timestamp: '2021-09-08T13: 59: 45',
fill_bbl: 732345,
fill_tons: 100132.79950499999,
fill_cbm: 116434.06685999999,
reference_data_version: '20210906-1631611377217'
}
```
"""
api_params: Dict[str, Any] = {
"asset_tank_ids": convert_to_list(asset_tank_ids),
"corporate_entity_ids": convert_to_list(corporate_entity_ids),
"crude_confidence": convert_to_list(crude_confidence),
"location_ids": convert_to_list(location_ids),
"measurement_ids": convert_to_list(measurement_ids),
"offset": offset,
"order": order,
"order_direction": order_direction,
"size": size if size is not None else self._MAX_PAGE_RESULT_SIZE,
"storage_types": convert_to_list(storage_types),
"time_min": to_ISODate(time_min) if time_min is not None else None,
"time_max": to_ISODate(time_max) if time_max is not None else None,
}
response = super().search_with_client_with_search_after(**api_params)
return OnshoreInventoriesResult(
records=response["data"], reference=response["reference"]
)