synmax-api-python-client 4.2.2__py3-none-any.whl → 4.5.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -81,6 +81,13 @@ class HyperionApiClient(object):
81
81
  def fetch_tils_expanded(self) -> pandas.DataFrame:
82
82
  return self.api_client_sync.get(f"{self._base_uri}/v3/tils_expanded", return_json=True)
83
83
 
84
+ def fetch_til_wells(self) -> pandas.DataFrame:
85
+ return self.api_client_sync.get(f"{self._base_uri}/v3/til_wells", return_json=True)
86
+
87
+ def fetch_til_wells_expanded(self) -> pandas.DataFrame:
88
+ return self.api_client_sync.get(f"{self._base_uri}/v3/til_wells_expanded", return_json=True)
89
+
90
+
84
91
  def fetch_forecast_run_dates(self) -> pandas.DataFrame:
85
92
  return self.api_client_sync.get(
86
93
  f"{self._base_uri}/v3/shorttermforecasthistorydates", return_json=True
@@ -27,4 +27,5 @@ class HyperionApiClient(OpenAPIClient):
27
27
  headers={"Access-Key": access_token},
28
28
  logger=logger,
29
29
  timeout=timeout,
30
+ retry_sleep=retry_sleep
30
31
  )
@@ -2,8 +2,8 @@ from typing import Literal, Union
2
2
  from synmax.openapi.client import Result
3
3
  from datetime import date
4
4
  class HyperionApiClient:
5
- def well_completion(self,aggregate_by: list[Literal['county', 'date_end', 'date_start', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas']] = ...,completion_class: Union[list[Literal['oil', 'gas', 'TBD']], Literal['oil', 'gas', 'TBD']] = ...,county: Union[list[str], str] = ...,date_completion_start_min: date = ...,date_completion_start_max: date = ...,date_completion_end_min: date = ...,date_completion_end_max: date = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
6
- """Well completions. Well level frac jobs by date"""
5
+ def well_completion(self,aggregate_by: list[Literal['county', 'date_completion_start', 'date_completion_end', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas']] = ...,completion_class: Union[list[Literal['oil', 'gas', 'TBD']], Literal['oil', 'gas', 'TBD']] = ...,county: Union[list[str], str] = ...,date_completion_start_min: date = ...,date_completion_start_max: date = ...,date_completion_end_min: date = ...,date_completion_end_max: date = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
6
+ """Well completions. Well level frac jobs by date."""
7
7
  ...
8
8
  def daily_fracked_feet(self,date_frac_min: date = ...,date_frac_max: date = ...,region_natgas: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
9
9
  """Fracked feet per day averaged by subregion."""
@@ -11,6 +11,9 @@ class HyperionApiClient:
11
11
  def daily_production(self,aggregate_by: list[Literal['date_prod', 'region_natgas', 'sub_region_natgas']] = ...,date_prod_min: date = ...,date_prod_max: date = ...,region_natgas: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
12
12
  """Returns the daily gas production model for the lower 48, informed from pipeline scrapes, state data, and our short-term production forecast."""
13
13
  ...
14
+ def dry_gas_factors(self,date_factor_min: date = ...,date_factor_max: date = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
15
+ """Monthly dry gas factors by natgas subregion"""
16
+ ...
14
17
  def ducs_by_operator(self,aggregate_by: list[Literal['county', 'date_observed', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas']] = ...,county: Union[list[str], str] = ...,date_observed_min: date = ...,date_observed_max: date = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
15
18
  """Count of drilled but uncompleted wells by county and operator"""
16
19
  ...
@@ -47,7 +50,7 @@ class HyperionApiClient:
47
50
  def fetch_tils(self) -> Result:
48
51
  """TIL monitoring data."""
49
52
  ...
50
- def wells(self,aggregate_by: list[Literal['county', 'date_first_production', 'date_spud', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas']] = ...,county: Union[list[str], str] = ...,date_spud_min: date = ...,date_spud_max: date = ...,date_first_production_min: date = ...,date_first_production_max: date = ...,depth_min: float = ...,depth_max: float = ...,horizontal_length_min: float = ...,horizontal_length_max: float = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
53
+ def wells(self,aggregate_by: list[Literal['county', 'date_first_production', 'date_spud', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas']] = ...,county: Union[list[str], str] = ...,date_spud_min: date = ...,date_spud_max: date = ...,date_first_production_min: date = ...,date_first_production_max: date = ...,depth_min: float = ...,depth_max: float = ...,horizontal_length_min: float = ...,horizontal_length_max: float = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...,well_id: Union[list[str], str] = ...,wellpad_id: Union[list[int], int] = ...) -> Result:
51
54
  """Well level details. Well level data derived from all sources."""
52
55
  ...
53
56
  def frac_crews(self,aggregate_by: list[Literal['county', 'date_frac', 'operator', 'region_natgas', 'service_company', 'state_code', 'sub_region_natgas']] = ...,county: Union[list[str], str] = ...,date_frac_min: date = ...,date_frac_max: date = ...,frac_class: Union[list[Literal['oil', 'gas', 'TBD']], Literal['oil', 'gas', 'TBD']] = ...,operator: Union[list[str], str] = ...,region_natgas: Union[list[str], str] = ...,service_company: list[str] = ...,state_code: Union[list[str], str] = ...,sub_region_natgas: Union[list[str], str] = ...) -> Result:
@@ -12,23 +12,25 @@ paths:
12
12
  post:
13
13
  x-method-name: well_completion
14
14
  security: [ApiKeyAuth: [hyperion]]
15
- summary: Well completions. Well level frac jobs by date
15
+ summary: Well completions. Well level frac jobs by date.
16
16
  requestBody:
17
17
  content:
18
18
  application/json:
19
19
  schema:
20
20
  type: object
21
21
  additionalProperties: false
22
+ nullable: true
22
23
  properties:
23
24
  aggregate_by:
25
+ description: Fields to aggregate over
24
26
  type: array
25
27
  items:
26
28
  type: string
27
29
  example: region_natgas
28
30
  enum:
29
31
  - county
30
- - date_end
31
- - date_start
32
+ - date_completion_start
33
+ - date_completion_end
32
34
  - operator
33
35
  - region_natgas
34
36
  - state_code
@@ -52,30 +54,31 @@ paths:
52
54
  application/x-ndjson:
53
55
  schema: { $ref: '#/components/schemas/WellCompletionsResponse' }
54
56
  /dailyfrackedfeet:
55
- post:
56
- x-method-name: daily_fracked_feet
57
- summary: Fracked feet per day averaged by subregion.
58
- security: [ApiKeyAuth: [hyperion]]
59
- requestBody:
60
- required: true
57
+ post:
58
+ x-method-name: daily_fracked_feet
59
+ summary: Fracked feet per day averaged by subregion.
60
+ security: [ApiKeyAuth: [hyperion]]
61
+ requestBody:
62
+ required: true
63
+ content:
64
+ application/json:
65
+ schema:
66
+ type: object
67
+ additionalProperties: false
68
+ nullable: true
69
+ properties:
70
+ date_frac_min: { $ref: '#/components/schemas/date' }
71
+ date_frac_max: { $ref: '#/components/schemas/date' }
72
+ region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
73
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
74
+ responses:
75
+ '200':
76
+ description: Success
61
77
  content:
62
78
  application/json:
63
- schema:
64
- type: object
65
- additionalProperties: false
66
- properties:
67
- date_frac_min: { $ref: '#/components/schemas/date' }
68
- date_frac_max: { $ref: '#/components/schemas/date' }
69
- region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
70
- sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
71
- responses:
72
- '200':
73
- description: Success
74
- content:
75
- application/json:
76
- schema: { $ref: '#/components/schemas/DailyFrackedFeetResponse' }
77
- application/x-ndjson:
78
- schema: { $ref: '#/components/schemas/DailyFrackedFeetResponse' }
79
+ schema: { $ref: '#/components/schemas/DailyFrackedFeetResponse' }
80
+ application/x-ndjson:
81
+ schema: { $ref: '#/components/schemas/DailyFrackedFeetResponse' }
79
82
  /dailyproduction:
80
83
  post:
81
84
  x-method-name: daily_production
@@ -88,8 +91,10 @@ paths:
88
91
  schema:
89
92
  type: object
90
93
  additionalProperties: false
94
+ nullable: true
91
95
  properties:
92
96
  aggregate_by:
97
+ description: Fields to aggregate over
93
98
  type: array
94
99
  items:
95
100
  type: string
@@ -107,46 +112,73 @@ paths:
107
112
  schema: { $ref: '#/components/schemas/DailyProductionResponse' }
108
113
  application/x-ndjson:
109
114
  schema: { $ref: '#/components/schemas/DailyProductionResponse' }
115
+ /drygasfactors:
116
+ post:
117
+ x-method-name: dry_gas_factors
118
+ summary: Monthly dry gas factors by natgas subregion
119
+ security: [ApiKeyAuth: [hyperion]]
120
+ requestBody:
121
+ required: true
122
+ content:
123
+ application/json:
124
+ schema:
125
+ type: object
126
+ additionalProperties: false
127
+ nullable: true
128
+ properties:
129
+ date_factor_min: { $ref: '#/components/schemas/date' }
130
+ date_factor_max: { $ref: '#/components/schemas/date' }
131
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
132
+ responses:
133
+ '200':
134
+ description: Success
135
+ content:
136
+ application/json:
137
+ schema: { $ref: '#/components/schemas/DryGasFactorResponse' }
138
+ application/x-ndjson:
139
+ schema: { $ref: '#/components/schemas/DryGasFactorResponse' }
110
140
  /ducsbyoperator:
111
- post:
112
- x-method-name: ducs_by_operator
113
- summary: Count of drilled but uncompleted wells by county and operator
114
- security: [ApiKeyAuth: [hyperion]]
115
- requestBody:
116
- required: true
141
+ post:
142
+ x-method-name: ducs_by_operator
143
+ summary: Count of drilled but uncompleted wells by county and operator
144
+ security: [ApiKeyAuth: [hyperion]]
145
+ requestBody:
146
+ required: true
147
+ content:
148
+ application/json:
149
+ schema:
150
+ type: object
151
+ additionalProperties: false
152
+ nullable: true
153
+ properties:
154
+ aggregate_by:
155
+ description: Fields to aggregate over
156
+ type: array
157
+ items:
158
+ type: string
159
+ example: region_natgas
160
+ enum:
161
+ - county
162
+ - date_observed
163
+ - operator
164
+ - region_natgas
165
+ - state_code
166
+ - sub_region_natgas
167
+ county: { $ref: '#/components/schemas/county_array' }
168
+ date_observed_min: { $ref: '#/components/schemas/date' }
169
+ date_observed_max: { $ref: '#/components/schemas/date' }
170
+ operator: { $ref: '#/components/schemas/operator_array' }
171
+ region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
172
+ state_code: { $ref: '#/components/schemas/state_code_array' }
173
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
174
+ responses:
175
+ '200':
176
+ description: Success
117
177
  content:
118
178
  application/json:
119
- schema:
120
- type: object
121
- additionalProperties: false
122
- properties:
123
- aggregate_by:
124
- type: array
125
- items:
126
- type: string
127
- example: region_natgas
128
- enum:
129
- - county
130
- - date_observed
131
- - operator
132
- - region_natgas
133
- - state_code
134
- - sub_region_natgas
135
- county: { $ref: '#/components/schemas/county_array' }
136
- date_observed_min: { $ref: '#/components/schemas/date' }
137
- date_observed_max: { $ref: '#/components/schemas/date' }
138
- operator: { $ref: '#/components/schemas/operator_array' }
139
- region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
140
- state_code: { $ref: '#/components/schemas/state_code_array' }
141
- sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
142
- responses:
143
- '200':
144
- description: Success
145
- content:
146
- application/json:
147
- schema: { $ref: '#/components/schemas/DucsByOperatorResponse' }
148
- application/x-ndjson:
149
- schema: { $ref: '#/components/schemas/DucsByOperatorResponse' }
179
+ schema: { $ref: '#/components/schemas/DucsByOperatorResponse' }
180
+ application/x-ndjson:
181
+ schema: { $ref: '#/components/schemas/DucsByOperatorResponse' }
150
182
  /longtermforecast:
151
183
  post:
152
184
  x-method-name: long_term_forecast
@@ -159,8 +191,10 @@ paths:
159
191
  schema:
160
192
  type: object
161
193
  additionalProperties: false
194
+ nullable: true
162
195
  properties:
163
196
  aggregate_by:
197
+ description: Fields to aggregate over
164
198
  type: array
165
199
  items:
166
200
  type: string
@@ -194,6 +228,38 @@ paths:
194
228
  schema: { $ref: '#/components/schemas/OperatorClassificationResponse' }
195
229
  application/x-ndjson:
196
230
  schema: { $ref: '#/components/schemas/OperatorClassificationResponse' }
231
+ /oilproduction:
232
+ post:
233
+ # x-method-name: oil_production
234
+ summary: Daily oil production by subregion
235
+ security: [ApiKeyAuth: [hyperion]]
236
+ requestBody:
237
+ required: true
238
+ content:
239
+ application/json:
240
+ schema:
241
+ type: object
242
+ additionalProperties: false
243
+ properties:
244
+ aggregate_by:
245
+ description: Fields to aggregate over
246
+ type: array
247
+ items:
248
+ type: string
249
+ example: region_natgas
250
+ enum: [ date_prod, region_natgas, sub_region_natgas ]
251
+ date_prod_min: { $ref: '#/components/schemas/date' }
252
+ date_prod_max: { $ref: '#/components/schemas/date' }
253
+ region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
254
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
255
+ responses:
256
+ '200':
257
+ description: Success
258
+ content:
259
+ application/json:
260
+ schema: { $ref: '#/components/schemas/OilProductionResponse' }
261
+ application/x-ndjson:
262
+ schema: { $ref: '#/components/schemas/OilProductionResponse' }
197
263
  /productionbywell:
198
264
  post:
199
265
  x-method-name: production_by_well
@@ -206,8 +272,10 @@ paths:
206
272
  schema:
207
273
  type: object
208
274
  additionalProperties: false
275
+ nullable: true
209
276
  properties:
210
277
  aggregate_by:
278
+ description: Fields to aggregate over
211
279
  type: array
212
280
  items:
213
281
  type: string
@@ -255,8 +323,10 @@ paths:
255
323
  schema:
256
324
  type: object
257
325
  additionalProperties: false
326
+ nullable: true
258
327
  properties:
259
328
  aggregate_by:
329
+ description: Fields to aggregate over
260
330
  type: array
261
331
  items:
262
332
  type: string
@@ -289,8 +359,10 @@ paths:
289
359
  schema:
290
360
  type: object
291
361
  additionalProperties: false
362
+ nullable: true
292
363
  properties:
293
364
  aggregate_by:
365
+ description: Fields to aggregate over
294
366
  type: array
295
367
  items:
296
368
  type: string
@@ -324,8 +396,10 @@ paths:
324
396
  schema:
325
397
  type: object
326
398
  additionalProperties: false
399
+ nullable: true
327
400
  properties:
328
401
  aggregate_by:
402
+ description: Fields to aggregate over
329
403
  type: array
330
404
  items:
331
405
  type: string
@@ -365,8 +439,10 @@ paths:
365
439
  schema:
366
440
  type: object
367
441
  additionalProperties: false
442
+ nullable: true
368
443
  properties:
369
444
  aggregate_by:
445
+ description: Fields to aggregate over
370
446
  type: array
371
447
  items:
372
448
  type: string
@@ -388,12 +464,16 @@ paths:
388
464
  date_prod_max: { $ref: '#/components/schemas/date' }
389
465
  first_production_month_min: { $ref: '#/components/schemas/date' }
390
466
  first_production_month_max: { $ref: '#/components/schemas/date' }
391
- modeled: { type: boolean }
467
+ modeled:
468
+ description: The production numbers are from our forecast
469
+ type: boolean
392
470
  operator: { $ref: '#/components/schemas/operator_array' }
393
471
  production_month: { $ref: '#/components/schemas/integer_array' }
394
472
  region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
395
473
  state_code: { $ref: '#/components/schemas/state_code_array' }
396
- state_reported: { type: boolean }
474
+ state_reported:
475
+ description: Has the state published any production numbers for this well
476
+ type: boolean
397
477
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
398
478
  well_id: { $ref: '#/components/schemas/well_id_array' }
399
479
  responses:
@@ -419,6 +499,7 @@ paths:
419
499
  required: [date_forecast_run]
420
500
  properties:
421
501
  aggregate_by:
502
+ description: Fields to aggregate over
422
503
  type: array
423
504
  items:
424
505
  type: string
@@ -472,6 +553,7 @@ paths:
472
553
  schema:
473
554
  type: object
474
555
  additionalProperties: false
556
+ nullable: true
475
557
  properties:
476
558
  date_forecast_run: { $ref: '#/components/schemas/date' }
477
559
  date_prod_min: { $ref: '#/components/schemas/date' }
@@ -510,8 +592,10 @@ paths:
510
592
  schema:
511
593
  type: object
512
594
  additionalProperties: false
595
+ nullable: true
513
596
  properties:
514
597
  aggregate_by:
598
+ description: Fields to aggregate over
515
599
  type: array
516
600
  items:
517
601
  type: string
@@ -537,6 +621,8 @@ paths:
537
621
  region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
538
622
  state_code: { $ref: '#/components/schemas/state_code_array' }
539
623
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
624
+ well_id: { $ref: '#/components/schemas/well_id_array' }
625
+ wellpad_id: { $ref: '#/components/schemas/wellpad_id_array' }
540
626
  responses:
541
627
  '200':
542
628
  description: Success
@@ -599,8 +685,10 @@ paths:
599
685
  schema:
600
686
  type: object
601
687
  additionalProperties: false
688
+ nullable: true
602
689
  properties:
603
690
  aggregate_by:
691
+ description: Fields to aggregate over
604
692
  type: array
605
693
  items:
606
694
  type: string
@@ -641,8 +729,10 @@ paths:
641
729
  schema:
642
730
  type: object
643
731
  additionalProperties: false
732
+ nullable: true
644
733
  properties:
645
734
  aggregate_by:
735
+ description: Fields to aggregate over
646
736
  type: array
647
737
  items:
648
738
  type: string
@@ -700,6 +790,7 @@ paths:
700
790
  schema:
701
791
  type: object
702
792
  additionalProperties: false
793
+ nullable: true
703
794
  properties:
704
795
  county: { $ref: '#/components/schemas/county_array' }
705
796
  date_spud_min: { $ref: '#/components/schemas/date' }
@@ -733,6 +824,7 @@ paths:
733
824
  schema:
734
825
  type: object
735
826
  additionalProperties: false
827
+ nullable: true
736
828
  properties: {}
737
829
  responses:
738
830
  '200':
@@ -742,6 +834,42 @@ paths:
742
834
  schema: { $ref: '#/components/schemas/Lower48TotalSTFResponse' }
743
835
  application/x-ndjson:
744
836
  schema: { $ref: '#/components/schemas/Lower48TotalSTFResponse' }
837
+ /wellpadstatus:
838
+ post:
839
+ security: [ApiKeyAuth: [hyperion]]
840
+ summary: Interpolated wellpad status by date
841
+ requestBody:
842
+ required: false
843
+ content:
844
+ application/json:
845
+ schema:
846
+ type: object
847
+ additionalProperties: false
848
+ nullable: true
849
+ properties:
850
+ aggregate_by:
851
+ type: array
852
+ items:
853
+ type: string
854
+ example: region_natgas
855
+ enum: [ date_status, region_natgas, sub_region_natgas ]
856
+ county: { $ref: '#/components/schemas/county_array' }
857
+ date_status_min: { $ref: '#/components/schemas/date' }
858
+ date_status_max: { $ref: '#/components/schemas/date' }
859
+ operator: { $ref: '#/components/schemas/operator_array' }
860
+ region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
861
+ state_code: { $ref: '#/components/schemas/state_code_array' }
862
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
863
+ wellpad_id: { type: string }
864
+ wellpad_status: { $ref: '#/components/schemas/wellpad_status' }
865
+ responses:
866
+ '200':
867
+ description: Successful response
868
+ content:
869
+ application/json:
870
+ schema: { $ref: '#/components/schemas/WellpadStatusResponse' }
871
+ application/x-ndjson:
872
+ schema: { $ref: '#/components/schemas/WellpadStatusResponse' }
745
873
  /beta/complete_report_date:
746
874
  post:
747
875
  x-method-name: beta_complete_report_date
@@ -753,6 +881,7 @@ paths:
753
881
  schema:
754
882
  type: object
755
883
  additionalProperties: false
884
+ nullable: true
756
885
  properties:
757
886
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
758
887
  responses:
@@ -784,15 +913,28 @@ components:
784
913
  prod_dry_gas_bcf_day: { type: number }
785
914
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
786
915
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
916
+ DryGasFactorResponse:
917
+ type: object
918
+ properties:
919
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
920
+ date_factor:
921
+ type: string
922
+ format: date
923
+ example: 2024-11-01
924
+ description: The month during which this dry gas factor applies
925
+ dry_gas_factor:
926
+ type: number
927
+ description: The dry gas factor
928
+ example: 0.866
787
929
  DucsByOperatorResponse:
788
930
  type: object
789
931
  properties:
790
932
  county: { $ref: '#/components/schemas/county' }
791
933
  date_observed: { $ref: '#/components/schemas/date' }
792
934
  ducs_count: { type: integer }
793
- operator: { type: string }
935
+ operator: { $ref: '#/components/schemas/operator' }
794
936
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
795
- state_code: { type: string }
937
+ state_code: { $ref: '#/components/schemas/state_code' }
796
938
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
797
939
  FracCrewsResponse:
798
940
  type: object
@@ -800,8 +942,12 @@ components:
800
942
  county: { $ref: '#/components/schemas/county' }
801
943
  date_frac: { $ref: '#/components/schemas/date' }
802
944
  frac_class: { $ref: '#/components/schemas/frac_class' }
803
- lat: { type: number }
804
- long: { type: number }
945
+ lat:
946
+ type: number
947
+ description: Latitude of the wellpad
948
+ long:
949
+ type: number
950
+ description: Longitude of the wellpad
805
951
  count: { type: integer }
806
952
  operator: { $ref: '#/components/schemas/operator' }
807
953
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
@@ -823,10 +969,19 @@ components:
823
969
  elevation_ground: { type: number }
824
970
  field_name: { type: string }
825
971
  formation: { type: string }
826
- lat_bottomhole: { type: number }
827
- lat_surface: { type: number }
828
- lon_bottomhole: { type: number }
829
- lon_surface: { type: number }
972
+ horizontal_length: { type: number }
973
+ lat_bottomhole:
974
+ type: number
975
+ description: Latitude of the end of the well
976
+ lon_bottomhole:
977
+ type: number
978
+ description: Longitude of the end of the well
979
+ lat_surface:
980
+ type: number
981
+ description: Latitude of the wellbore
982
+ lon_surface:
983
+ type: number
984
+ description: Longitude of the wellbore
830
985
  lower_perf: { type: number }
831
986
  operator: { $ref: '#/components/schemas/operator' }
832
987
  product_type: { type: string }
@@ -846,8 +1001,12 @@ components:
846
1001
  GeoWellsResponse:
847
1002
  type: object
848
1003
  properties:
849
- lat_surface: { type: number }
850
- lon_surface: { type: number }
1004
+ lat_surface:
1005
+ type: number
1006
+ description: Latitude of the wellbore
1007
+ lon_surface:
1008
+ type: number
1009
+ description: Longitude of the wellbore
851
1010
  well_id: { $ref: '#/components/schemas/well_id' }
852
1011
  LongTermForecastResponse:
853
1012
  type: object
@@ -857,37 +1016,44 @@ components:
857
1016
  prod_oil_bbl_day: { type: number }
858
1017
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
859
1018
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
860
- OperatorClassificationResponse:
861
- type: object
862
- properties:
863
- operator: { type: string }
864
- public_or_private: { type: string }
865
- ticker: { type: string }
866
- PipelineScrapesResponse:
1019
+ OilProductionResponse:
867
1020
  type: object
868
1021
  properties:
869
- county: { $ref: '#/components/schemas/county' }
870
- date_observed: { $ref: '#/components/schemas/date' }
871
- id: { type: integer }
872
- location_name: { type: string }
873
- pipe_point_type: { $ref: '#/components/schemas/pipe_point_type' }
874
- pipeline_name: { type: string }
875
- prod_dry_gas_mcf_day: { type: number }
876
- rec_del: { type: integer }
1022
+ date_prod: { $ref: '#/components/schemas/date' }
1023
+ prod_oil_bbl_day: { type: number }
877
1024
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
878
- source: { type: string }
879
- state_code: { type: string }
880
1025
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
881
- PipelineScrapesStatusResponse:
1026
+ OperatorClassificationResponse:
882
1027
  type: object
883
1028
  properties:
884
- date_observed: { $ref: '#/components/schemas/date' }
885
- pipe_id1_pct: { type: number }
886
- pipe_id2_pct: { type: number }
887
- pipe_id3_pct: { type: number }
888
- pipe_other_cycles_pct: { type: number }
889
- pipe_points_reporting_pct: { type: number }
890
- pipe_timely_pct: { type: number }
1029
+ operator: { $ref: '#/components/schemas/operator' }
1030
+ public_or_private: { type: string }
1031
+ ticker: { type: string }
1032
+ # PipelineScrapesResponse:
1033
+ # type: object
1034
+ # properties:
1035
+ # county: { $ref: '#/components/schemas/county' }
1036
+ # date_observed: { $ref: '#/components/schemas/date' }
1037
+ # id: { type: integer }
1038
+ # location_name: { type: string }
1039
+ # pipe_point_type: { $ref: '#/components/schemas/pipe_point_type' }
1040
+ # pipeline_name: { type: string }
1041
+ # prod_dry_gas_mcf_day: { type: number }
1042
+ # rec_del: { type: integer }
1043
+ # region_natgas: { $ref: '#/components/schemas/region_natgas' }
1044
+ # source: { type: string }
1045
+ # state_code: { type: string }
1046
+ # sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1047
+ # PipelineScrapesStatusResponse:
1048
+ # type: object
1049
+ # properties:
1050
+ # date_observed: { $ref: '#/components/schemas/date' }
1051
+ # pipe_id1_pct: { type: number }
1052
+ # pipe_id2_pct: { type: number }
1053
+ # pipe_id3_pct: { type: number }
1054
+ # pipe_other_cycles_pct: { type: number }
1055
+ # pipe_points_reporting_pct: { type: number }
1056
+ # pipe_timely_pct: { type: number }
891
1057
  ProductionByWellResponse:
892
1058
  type: object
893
1059
  properties:
@@ -902,7 +1068,7 @@ components:
902
1068
  prod_water_bbl_month: { type: number }
903
1069
  prod_wet_gas_mcf_day: { type: number }
904
1070
  prod_wet_gas_mcf_month: { type: number }
905
- production_month: { type: integer }
1071
+ production_month: { $ref: '#/components/schemas/production_month' }
906
1072
  range: { type: string }
907
1073
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
908
1074
  section: { type: string }
@@ -925,8 +1091,12 @@ components:
925
1091
  count: { type: integer }
926
1092
  county: { $ref: '#/components/schemas/county' }
927
1093
  date_observed: { $ref: '#/components/schemas/date' }
928
- lat: { type: number }
929
- long: { type: number }
1094
+ lat:
1095
+ type: number
1096
+ description: Latitude of the wellpad
1097
+ long:
1098
+ type: number
1099
+ description: Longitude of the wellpad
930
1100
  operator: { $ref: '#/components/schemas/operator' }
931
1101
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
932
1102
  rig_class: { $ref: '#/components/schemas/rig_class' }
@@ -949,16 +1119,20 @@ components:
949
1119
  date_forecast_run: { $ref: '#/components/schemas/date' }
950
1120
  date_prod: { $ref: '#/components/schemas/date' }
951
1121
  first_production_month: { $ref: '#/components/schemas/date' }
952
- modeled: { type: boolean }
1122
+ modeled:
1123
+ description: The production numbers are from our forecast
1124
+ type: boolean
953
1125
  operator: { $ref: '#/components/schemas/operator' }
954
1126
  prod_oil_bbl_day: { type: number }
955
1127
  prod_oil_bbl_month: { type: number }
956
1128
  prod_wet_gas_mcf_day: { type: number }
957
1129
  prod_wet_gas_mcf_month: { type: number }
958
- production_month: { type: integer }
1130
+ production_month: { $ref: '#/components/schemas/production_month' }
959
1131
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
960
1132
  state_code: { $ref: '#/components/schemas/state_code' }
961
- state_reported: { type: boolean }
1133
+ state_reported:
1134
+ description: Has the state published any production numbers for this well
1135
+ type: boolean
962
1136
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
963
1137
  well_id: { $ref: '#/components/schemas/well_id' }
964
1138
  ShortTermForecastResponse:
@@ -986,7 +1160,7 @@ components:
986
1160
  county: { $ref: '#/components/schemas/county' }
987
1161
  date_forecast_run: { $ref: '#/components/schemas/date' }
988
1162
  date_prod: { $ref: '#/components/schemas/date' }
989
- operator: { type: string }
1163
+ operator: { $ref: '#/components/schemas/operator' }
990
1164
  prod_oil_bbl_day: { type: number }
991
1165
  prod_oil_bbl_month: { type: number }
992
1166
  prod_wet_gas_mcf_day: { type: number }
@@ -1000,7 +1174,7 @@ components:
1000
1174
  properties:
1001
1175
  date_frac_end: { $ref: '#/components/schemas/date' }
1002
1176
  date_til: { $ref: '#/components/schemas/date' }
1003
- operator: { type: string }
1177
+ operator: { $ref: '#/components/schemas/operator' }
1004
1178
  prod_wet_gas_bcf_day: { type: number }
1005
1179
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1006
1180
  wellpad_id: { type: string }
@@ -1016,17 +1190,25 @@ components:
1016
1190
  depth_measured: { type: number }
1017
1191
  depth_tvd: { type: number }
1018
1192
  horizontal_length: { type: number }
1019
- lat_bottomhole: { type: number }
1020
- lon_bottomhole: { type: number }
1021
- lat_surface: { type: number }
1022
- lon_surface: { type: number }
1023
- operator: { type: string }
1193
+ lat_bottomhole:
1194
+ type: number
1195
+ description: Latitude of the end of the well
1196
+ lon_bottomhole:
1197
+ type: number
1198
+ description: Longitude of the end of the well
1199
+ lat_surface:
1200
+ type: number
1201
+ description: Latitude of the wellbore
1202
+ lon_surface:
1203
+ type: number
1204
+ description: Longitude of the wellbore
1205
+ operator: { $ref: '#/components/schemas/operator' }
1024
1206
  region_natgas: { $ref: '#/components/schemas/region_natgas' }
1025
- state_code: { type: string }
1207
+ state_code: { $ref: '#/components/schemas/state_code' }
1026
1208
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1027
1209
  well_id: { $ref: '#/components/schemas/well_id' }
1028
1210
  wellbore_type: { type: string }
1029
- wellpad_id: { type: string }
1211
+ wellpad_id: { $ref: '#/components/schemas/wellpad_id' }
1030
1212
  WellCompletionsResponse:
1031
1213
  type: object
1032
1214
  properties:
@@ -1049,8 +1231,10 @@ components:
1049
1231
  aggregation_type:
1050
1232
  type: string
1051
1233
  example: sum
1234
+ description: The type of aggregation applied to data
1052
1235
  enum: [ average, count, sum ]
1053
1236
  completion_class:
1237
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1054
1238
  type: string
1055
1239
  example: oil
1056
1240
  enum:
@@ -1058,22 +1242,28 @@ components:
1058
1242
  - gas
1059
1243
  - TBD
1060
1244
  completion_class_array:
1245
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1061
1246
  anyOf:
1062
1247
  - type: array
1063
1248
  items: { $ref: '#/components/schemas/completion_class' }
1064
1249
  - $ref: '#/components/schemas/completion_class'
1065
1250
  county:
1251
+ description: A county
1066
1252
  type: string
1067
1253
  example: CAMPBELL
1068
1254
  county_array:
1255
+ description: A county
1069
1256
  anyOf:
1070
1257
  - type: array
1071
1258
  items: { $ref: '#/components/schemas/county' }
1072
1259
  - $ref: '#/components/schemas/county'
1073
1260
  date:
1261
+ description: A date in YYYY-MM-DD format
1074
1262
  type: string
1075
1263
  format: date
1264
+ example: '2021-11-24'
1076
1265
  frac_class:
1266
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1077
1267
  type: string
1078
1268
  example: oil
1079
1269
  enum:
@@ -1081,6 +1271,7 @@ components:
1081
1271
  - gas
1082
1272
  - TBD
1083
1273
  frac_class_array:
1274
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1084
1275
  anyOf:
1085
1276
  - type: array
1086
1277
  items: { $ref: '#/components/schemas/frac_class' }
@@ -1091,40 +1282,49 @@ components:
1091
1282
  items: { type: integer }
1092
1283
  - type: integer
1093
1284
  operator:
1285
+ description: A well operator
1094
1286
  example: BILL BARRETT CORPORATION
1095
1287
  type: string
1096
1288
  operator_array:
1289
+ description: A well operator
1097
1290
  anyOf:
1098
1291
  - type: array
1099
1292
  items: { $ref: '#/components/schemas/operator' }
1100
1293
  - $ref: '#/components/schemas/operator'
1101
- pipe_point_type:
1102
- type: string
1103
- example: Wellhead
1104
- enum:
1105
- - Compressor
1106
- - Gathering System
1107
- - Industrial
1108
- - Interconnect
1109
- - LDC
1110
- - LNG
1111
- - Pooling Point
1112
- - Power
1113
- - Processing Plant
1114
- - Production
1115
- - RNG
1116
- - Storage
1117
- - Virtual Point
1118
- - Wellhead
1294
+ production_month:
1295
+ description: The number of months this well has been producing
1296
+ type: integer
1297
+ # pipe_point_type:
1298
+ # description: TODO
1299
+ # type: string
1300
+ # example: Wellhead
1301
+ # enum:
1302
+ # - Compressor
1303
+ # - Gathering System
1304
+ # - Industrial
1305
+ # - Interconnect
1306
+ # - LDC
1307
+ # - LNG
1308
+ # - Pooling Point
1309
+ # - Power
1310
+ # - Processing Plant
1311
+ # - Production
1312
+ # - RNG
1313
+ # - Storage
1314
+ # - Virtual Point
1315
+ # - Wellhead
1119
1316
  region_natgas:
1317
+ description: Region divisions based on natural gas production profiles
1120
1318
  example: west
1121
1319
  type: string
1122
1320
  region_natgas_array:
1321
+ description: Region divisions based on natural gas production profiles
1123
1322
  anyOf:
1124
1323
  - type: array
1125
1324
  items: { $ref: '#/components/schemas/region_natgas' }
1126
1325
  - $ref: '#/components/schemas/region_natgas'
1127
1326
  rig_class:
1327
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1128
1328
  type: string
1129
1329
  example: oil
1130
1330
  enum:
@@ -1132,14 +1332,17 @@ components:
1132
1332
  - gas
1133
1333
  - TBD
1134
1334
  rig_class_array:
1335
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1135
1336
  anyOf:
1136
1337
  - type: array
1137
1338
  items: { $ref: '#/components/schemas/rig_class' }
1138
1339
  - $ref: '#/components/schemas/rig_class'
1139
1340
  state_code:
1341
+ description: A state abbreviation
1140
1342
  type: string
1141
1343
  example: WY
1142
1344
  state_code_array:
1345
+ description: Oil/Gas classification based on EIA-defined gas/oil production ratios
1143
1346
  anyOf:
1144
1347
  - type: array
1145
1348
  items: { $ref: '#/components/schemas/state_code' }
@@ -1148,27 +1351,43 @@ components:
1148
1351
  type: array
1149
1352
  items: { type: string }
1150
1353
  sub_region_natgas:
1354
+ description: Subregion divisions based on natural gas production profiles
1151
1355
  type: string
1152
1356
  example: Haynesville - TX
1153
1357
  sub_region_natgas_array:
1358
+ description: Subregion divisions based on natural gas production profiles
1154
1359
  anyOf:
1155
1360
  - type: array
1156
1361
  items: { $ref: '#/components/schemas/sub_region_natgas' }
1157
1362
  - $ref: '#/components/schemas/sub_region_natgas'
1363
+ well_id:
1364
+ description: A well identifier
1365
+ type: string
1366
+ example: 4900552885
1158
1367
  well_id_array:
1368
+ description: Subregion divisions based on natural gas production profiles
1159
1369
  anyOf:
1160
1370
  - type: array
1161
1371
  items: { $ref: '#/components/schemas/well_id' }
1162
1372
  - $ref: '#/components/schemas/well_id'
1163
- well_id:
1373
+ wellpad_id:
1374
+ type: integer
1375
+ example: 717476
1376
+ wellpad_id_array:
1377
+ anyOf:
1378
+ - type: array
1379
+ items: { $ref: '#/components/schemas/wellpad_id' }
1380
+ - $ref: '#/components/schemas/wellpad_id'
1381
+ wellpad_status:
1164
1382
  type: string
1165
- example: 4900552885
1383
+ example: Drilling
1384
+ enum:
1385
+ - Drilling
1386
+ - Fracking
1166
1387
  CompleteReportDateReponse:
1167
1388
  type: object
1168
1389
  properties:
1169
- sub_region_natgas:
1170
- type: string
1171
- description: The sub-region name
1390
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1172
1391
  date_pipe_scrape_report:
1173
1392
  type: string
1174
1393
  format: date
@@ -1185,3 +1404,15 @@ components:
1185
1404
  type: string
1186
1405
  format: date
1187
1406
  description: Complete production date for oil
1407
+ WellpadStatusResponse:
1408
+ type: object
1409
+ properties:
1410
+ count: { type: integer }
1411
+ county: { $ref: '#/components/schemas/county' }
1412
+ date_status: { $ref: '#/components/schemas/date' }
1413
+ operator: { $ref: '#/components/schemas/operator' }
1414
+ region_natgas: { $ref: '#/components/schemas/region_natgas' }
1415
+ state_code: { $ref: '#/components/schemas/state_code' }
1416
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1417
+ wellpad_id: { type: string }
1418
+ wellpad_status: { $ref: '#/components/schemas/wellpad_status' }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: synmax-api-python-client
3
- Version: 4.2.2
3
+ Version: 4.5.0
4
4
  Summary: Synmax API client
5
5
  Home-page: https://github.com/SynMaxDev/synmax-api-python-client.git
6
6
  Author: Eric Anderson and Deepa Aswathaiah
@@ -9,14 +9,14 @@ synmax/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  synmax/helpers/implicit_filters.py,sha256=7MM-Zdgi2ZOHvGqlw3iQN4KuVxRCRKWQ-BMZ99Mvql8,3774
10
10
  synmax/hyperion/__init__.py,sha256=98XxPjbAhyRD3WkJjAZDB0Js2X7Q0DdZuxGX67-aYRI,2369
11
11
  synmax/hyperion/create_simulation.py,sha256=yTMh-IY1cBLrxpDLSYpABP6qecbuoOBHUbokJiXSzhs,17067
12
- synmax/hyperion/hyperion_client.py,sha256=-Af73F3HvPNnbDwCyGET71LUtADp8pcF0Aw8wvbURxA,6924
12
+ synmax/hyperion/hyperion_client.py,sha256=Ea6PWdDD5nuRklnzCZKnXDMJBr1QbKXOQOZ5r2seX2w,7231
13
13
  synmax/hyperion/hyperion_payload.py,sha256=h_FybuePt8Mbn1OZJJiIHHsqHj-3eloULmepBOz4Aw4,4738
14
14
  synmax/hyperion/process_api.py,sha256=y3sNiM2X_h-QVRRsrW4VmkABfGKxPqqZGMiYNrpRrK0,6967
15
15
  synmax/hyperion/process_inputs.py,sha256=Dij1FTzdyv0yGvwQNYZ9yJTJ6vBf-9B4P2zmJeCo6UU,10796
16
16
  synmax/hyperion/v4/__init__.py,sha256=VpXU-_FP836dXUDcUFYr-0y0-ZrSM8aCtGE97Z2qbS4,55
17
- synmax/hyperion/v4/hyperion_client.py,sha256=Yo6HVmekIH3L-G6ABjlwdxXhcmCG0pV1HDl5p8O1shM,833
18
- synmax/hyperion/v4/hyperion_client.pyi,sha256=WjVBMwfW7cSD8pvThVrx4FRJ6OPrYJVkJFa3iCkso6k,7878
19
- synmax/hyperion/v4/openapi.yaml,sha256=0X3rQp4v9gSC25-KvUOlyo7lUB3uRgDB3fFcfQmqFf8,48210
17
+ synmax/hyperion/v4/hyperion_client.py,sha256=Bc_wOLX_D7IRFnqzMBMJYqHDKbugWW3cNygoj_g7a5o,869
18
+ synmax/hyperion/v4/hyperion_client.pyi,sha256=qjg_aXHVk7op9pCimGdCsP0-Bay3zcRjOPgK94lK5-0,8192
19
+ synmax/hyperion/v4/openapi.yaml,sha256=IzdHkZcRtduASgnYXY8Mjg6N1__6VLZmFIOT2pa-wLQ,57930
20
20
  synmax/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
21
21
  synmax/openapi/client.py,sha256=fe6npo842Z_9ar2SX7wTFz9Y7Jv9vN03zTumpnb1y64,8600
22
22
  synmax/openapi/utils.py,sha256=q6PsmUT0D58_AdOCM0ZNw1CrveiYVF4IQN4J6ticZ4Q,3689
@@ -26,7 +26,7 @@ test/test_api_client.py,sha256=HFWCu_xBgqQXc9p6k6YmP2gVrdCFwuhoDVqlxpN1Yoc,4713
26
26
  test/test_hyperion_client.py,sha256=aCb4bMBXWofa82MInXoU9tJ5wWsg5sBRv7B_CHvkrcg,1380
27
27
  test/test_hyperion_e2e.py,sha256=BPhZH7eVQZSsFcvPdonKjmLahnfsLy37Z2DHp0LGeHc,6247
28
28
  test/test_hyperion_helpers.py,sha256=R0G7oqKaoz6jLRACODJ1Cf2gA0gaMPQhOZRjKp4a6-s,2006
29
- synmax_api_python_client-4.2.2.dist-info/METADATA,sha256=lMcQxcOG1wNt1WhGoCm3WDjDrKcoeCGjhuSpaBh-lmA,4860
30
- synmax_api_python_client-4.2.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
31
- synmax_api_python_client-4.2.2.dist-info/top_level.txt,sha256=SAjmDfHlJzUmjoGCT1SnS4qGSLN_ZF-p58UN1yW5kB0,17
32
- synmax_api_python_client-4.2.2.dist-info/RECORD,,
29
+ synmax_api_python_client-4.5.0.dist-info/METADATA,sha256=SDSc7-TKW4CdZaxbHaSlCSvrVK9gBFOOd13Qzo4EYXc,4860
30
+ synmax_api_python_client-4.5.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
31
+ synmax_api_python_client-4.5.0.dist-info/top_level.txt,sha256=SAjmDfHlJzUmjoGCT1SnS4qGSLN_ZF-p58UN1yW5kB0,17
32
+ synmax_api_python_client-4.5.0.dist-info/RECORD,,