synmax-api-python-client 4.4.0__py3-none-any.whl → 4.6.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.
- synmax/hyperion/v4/hyperion_client.pyi +2 -2
- synmax/hyperion/v4/openapi.yaml +213 -75
- synmax/leviaton/__init__.py +0 -0
- synmax/leviaton/v1/__init__.py +5 -0
- synmax/leviaton/v1/leviaton_client.py +36 -0
- synmax/leviaton/v1/leviaton_client.pyi +89 -0
- synmax/leviaton/v1/openapi.yaml +3707 -0
- {synmax_api_python_client-4.4.0.dist-info → synmax_api_python_client-4.6.0.dist-info}/METADATA +1 -1
- {synmax_api_python_client-4.4.0.dist-info → synmax_api_python_client-4.6.0.dist-info}/RECORD +12 -6
- test/ip_rate_example.py +61 -0
- {synmax_api_python_client-4.4.0.dist-info → synmax_api_python_client-4.6.0.dist-info}/WHEEL +0 -0
- {synmax_api_python_client-4.4.0.dist-info → synmax_api_python_client-4.6.0.dist-info}/top_level.txt +0 -0
|
@@ -3,7 +3,7 @@ from synmax.openapi.client import Result
|
|
|
3
3
|
from datetime import date
|
|
4
4
|
class HyperionApiClient:
|
|
5
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"""
|
|
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."""
|
|
@@ -50,7 +50,7 @@ class HyperionApiClient:
|
|
|
50
50
|
def fetch_tils(self) -> Result:
|
|
51
51
|
"""TIL monitoring data."""
|
|
52
52
|
...
|
|
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] = ...) -> 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:
|
|
54
54
|
"""Well level details. Well level data derived from all sources."""
|
|
55
55
|
...
|
|
56
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:
|
synmax/hyperion/v4/openapi.yaml
CHANGED
|
@@ -12,7 +12,7 @@ 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:
|
|
@@ -22,6 +22,7 @@ paths:
|
|
|
22
22
|
nullable: true
|
|
23
23
|
properties:
|
|
24
24
|
aggregate_by:
|
|
25
|
+
description: Fields to aggregate over
|
|
25
26
|
type: array
|
|
26
27
|
items:
|
|
27
28
|
type: string
|
|
@@ -93,6 +94,7 @@ paths:
|
|
|
93
94
|
nullable: true
|
|
94
95
|
properties:
|
|
95
96
|
aggregate_by:
|
|
97
|
+
description: Fields to aggregate over
|
|
96
98
|
type: array
|
|
97
99
|
items:
|
|
98
100
|
type: string
|
|
@@ -150,6 +152,7 @@ paths:
|
|
|
150
152
|
nullable: true
|
|
151
153
|
properties:
|
|
152
154
|
aggregate_by:
|
|
155
|
+
description: Fields to aggregate over
|
|
153
156
|
type: array
|
|
154
157
|
items:
|
|
155
158
|
type: string
|
|
@@ -191,6 +194,7 @@ paths:
|
|
|
191
194
|
nullable: true
|
|
192
195
|
properties:
|
|
193
196
|
aggregate_by:
|
|
197
|
+
description: Fields to aggregate over
|
|
194
198
|
type: array
|
|
195
199
|
items:
|
|
196
200
|
type: string
|
|
@@ -238,6 +242,7 @@ paths:
|
|
|
238
242
|
additionalProperties: false
|
|
239
243
|
properties:
|
|
240
244
|
aggregate_by:
|
|
245
|
+
description: Fields to aggregate over
|
|
241
246
|
type: array
|
|
242
247
|
items:
|
|
243
248
|
type: string
|
|
@@ -270,6 +275,7 @@ paths:
|
|
|
270
275
|
nullable: true
|
|
271
276
|
properties:
|
|
272
277
|
aggregate_by:
|
|
278
|
+
description: Fields to aggregate over
|
|
273
279
|
type: array
|
|
274
280
|
items:
|
|
275
281
|
type: string
|
|
@@ -320,6 +326,7 @@ paths:
|
|
|
320
326
|
nullable: true
|
|
321
327
|
properties:
|
|
322
328
|
aggregate_by:
|
|
329
|
+
description: Fields to aggregate over
|
|
323
330
|
type: array
|
|
324
331
|
items:
|
|
325
332
|
type: string
|
|
@@ -355,6 +362,7 @@ paths:
|
|
|
355
362
|
nullable: true
|
|
356
363
|
properties:
|
|
357
364
|
aggregate_by:
|
|
365
|
+
description: Fields to aggregate over
|
|
358
366
|
type: array
|
|
359
367
|
items:
|
|
360
368
|
type: string
|
|
@@ -391,6 +399,7 @@ paths:
|
|
|
391
399
|
nullable: true
|
|
392
400
|
properties:
|
|
393
401
|
aggregate_by:
|
|
402
|
+
description: Fields to aggregate over
|
|
394
403
|
type: array
|
|
395
404
|
items:
|
|
396
405
|
type: string
|
|
@@ -433,6 +442,7 @@ paths:
|
|
|
433
442
|
nullable: true
|
|
434
443
|
properties:
|
|
435
444
|
aggregate_by:
|
|
445
|
+
description: Fields to aggregate over
|
|
436
446
|
type: array
|
|
437
447
|
items:
|
|
438
448
|
type: string
|
|
@@ -454,12 +464,16 @@ paths:
|
|
|
454
464
|
date_prod_max: { $ref: '#/components/schemas/date' }
|
|
455
465
|
first_production_month_min: { $ref: '#/components/schemas/date' }
|
|
456
466
|
first_production_month_max: { $ref: '#/components/schemas/date' }
|
|
457
|
-
modeled:
|
|
467
|
+
modeled:
|
|
468
|
+
description: The production numbers are from our forecast
|
|
469
|
+
type: boolean
|
|
458
470
|
operator: { $ref: '#/components/schemas/operator_array' }
|
|
459
471
|
production_month: { $ref: '#/components/schemas/integer_array' }
|
|
460
472
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
461
473
|
state_code: { $ref: '#/components/schemas/state_code_array' }
|
|
462
|
-
state_reported:
|
|
474
|
+
state_reported:
|
|
475
|
+
description: Has the state published any production numbers for this well
|
|
476
|
+
type: boolean
|
|
463
477
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas_array' }
|
|
464
478
|
well_id: { $ref: '#/components/schemas/well_id_array' }
|
|
465
479
|
responses:
|
|
@@ -485,6 +499,7 @@ paths:
|
|
|
485
499
|
required: [date_forecast_run]
|
|
486
500
|
properties:
|
|
487
501
|
aggregate_by:
|
|
502
|
+
description: Fields to aggregate over
|
|
488
503
|
type: array
|
|
489
504
|
items:
|
|
490
505
|
type: string
|
|
@@ -580,6 +595,7 @@ paths:
|
|
|
580
595
|
nullable: true
|
|
581
596
|
properties:
|
|
582
597
|
aggregate_by:
|
|
598
|
+
description: Fields to aggregate over
|
|
583
599
|
type: array
|
|
584
600
|
items:
|
|
585
601
|
type: string
|
|
@@ -605,6 +621,8 @@ paths:
|
|
|
605
621
|
region_natgas: { $ref: '#/components/schemas/region_natgas_array' }
|
|
606
622
|
state_code: { $ref: '#/components/schemas/state_code_array' }
|
|
607
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' }
|
|
608
626
|
responses:
|
|
609
627
|
'200':
|
|
610
628
|
description: Success
|
|
@@ -670,6 +688,7 @@ paths:
|
|
|
670
688
|
nullable: true
|
|
671
689
|
properties:
|
|
672
690
|
aggregate_by:
|
|
691
|
+
description: Fields to aggregate over
|
|
673
692
|
type: array
|
|
674
693
|
items:
|
|
675
694
|
type: string
|
|
@@ -713,6 +732,7 @@ paths:
|
|
|
713
732
|
nullable: true
|
|
714
733
|
properties:
|
|
715
734
|
aggregate_by:
|
|
735
|
+
description: Fields to aggregate over
|
|
716
736
|
type: array
|
|
717
737
|
items:
|
|
718
738
|
type: string
|
|
@@ -814,6 +834,42 @@ paths:
|
|
|
814
834
|
schema: { $ref: '#/components/schemas/Lower48TotalSTFResponse' }
|
|
815
835
|
application/x-ndjson:
|
|
816
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' }
|
|
817
873
|
/beta/complete_report_date:
|
|
818
874
|
post:
|
|
819
875
|
x-method-name: beta_complete_report_date
|
|
@@ -876,9 +932,9 @@ components:
|
|
|
876
932
|
county: { $ref: '#/components/schemas/county' }
|
|
877
933
|
date_observed: { $ref: '#/components/schemas/date' }
|
|
878
934
|
ducs_count: { type: integer }
|
|
879
|
-
operator: {
|
|
935
|
+
operator: { $ref: '#/components/schemas/operator' }
|
|
880
936
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
881
|
-
state_code: {
|
|
937
|
+
state_code: { $ref: '#/components/schemas/state_code' }
|
|
882
938
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
|
|
883
939
|
FracCrewsResponse:
|
|
884
940
|
type: object
|
|
@@ -886,8 +942,12 @@ components:
|
|
|
886
942
|
county: { $ref: '#/components/schemas/county' }
|
|
887
943
|
date_frac: { $ref: '#/components/schemas/date' }
|
|
888
944
|
frac_class: { $ref: '#/components/schemas/frac_class' }
|
|
889
|
-
lat:
|
|
890
|
-
|
|
945
|
+
lat:
|
|
946
|
+
type: number
|
|
947
|
+
description: Latitude of the wellpad
|
|
948
|
+
long:
|
|
949
|
+
type: number
|
|
950
|
+
description: Longitude of the wellpad
|
|
891
951
|
count: { type: integer }
|
|
892
952
|
operator: { $ref: '#/components/schemas/operator' }
|
|
893
953
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
@@ -910,10 +970,18 @@ components:
|
|
|
910
970
|
field_name: { type: string }
|
|
911
971
|
formation: { type: string }
|
|
912
972
|
horizontal_length: { type: number }
|
|
913
|
-
lat_bottomhole:
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
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
|
|
917
985
|
lower_perf: { type: number }
|
|
918
986
|
operator: { $ref: '#/components/schemas/operator' }
|
|
919
987
|
product_type: { type: string }
|
|
@@ -933,8 +1001,12 @@ components:
|
|
|
933
1001
|
GeoWellsResponse:
|
|
934
1002
|
type: object
|
|
935
1003
|
properties:
|
|
936
|
-
lat_surface:
|
|
937
|
-
|
|
1004
|
+
lat_surface:
|
|
1005
|
+
type: number
|
|
1006
|
+
description: Latitude of the wellbore
|
|
1007
|
+
lon_surface:
|
|
1008
|
+
type: number
|
|
1009
|
+
description: Longitude of the wellbore
|
|
938
1010
|
well_id: { $ref: '#/components/schemas/well_id' }
|
|
939
1011
|
LongTermForecastResponse:
|
|
940
1012
|
type: object
|
|
@@ -954,34 +1026,34 @@ components:
|
|
|
954
1026
|
OperatorClassificationResponse:
|
|
955
1027
|
type: object
|
|
956
1028
|
properties:
|
|
957
|
-
operator: {
|
|
1029
|
+
operator: { $ref: '#/components/schemas/operator' }
|
|
958
1030
|
public_or_private: { type: string }
|
|
959
1031
|
ticker: { type: string }
|
|
960
|
-
PipelineScrapesResponse:
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
PipelineScrapesStatusResponse:
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
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 }
|
|
985
1057
|
ProductionByWellResponse:
|
|
986
1058
|
type: object
|
|
987
1059
|
properties:
|
|
@@ -996,7 +1068,7 @@ components:
|
|
|
996
1068
|
prod_water_bbl_month: { type: number }
|
|
997
1069
|
prod_wet_gas_mcf_day: { type: number }
|
|
998
1070
|
prod_wet_gas_mcf_month: { type: number }
|
|
999
|
-
production_month: {
|
|
1071
|
+
production_month: { $ref: '#/components/schemas/production_month' }
|
|
1000
1072
|
range: { type: string }
|
|
1001
1073
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
1002
1074
|
section: { type: string }
|
|
@@ -1019,8 +1091,12 @@ components:
|
|
|
1019
1091
|
count: { type: integer }
|
|
1020
1092
|
county: { $ref: '#/components/schemas/county' }
|
|
1021
1093
|
date_observed: { $ref: '#/components/schemas/date' }
|
|
1022
|
-
lat:
|
|
1023
|
-
|
|
1094
|
+
lat:
|
|
1095
|
+
type: number
|
|
1096
|
+
description: Latitude of the wellpad
|
|
1097
|
+
long:
|
|
1098
|
+
type: number
|
|
1099
|
+
description: Longitude of the wellpad
|
|
1024
1100
|
operator: { $ref: '#/components/schemas/operator' }
|
|
1025
1101
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
1026
1102
|
rig_class: { $ref: '#/components/schemas/rig_class' }
|
|
@@ -1043,16 +1119,20 @@ components:
|
|
|
1043
1119
|
date_forecast_run: { $ref: '#/components/schemas/date' }
|
|
1044
1120
|
date_prod: { $ref: '#/components/schemas/date' }
|
|
1045
1121
|
first_production_month: { $ref: '#/components/schemas/date' }
|
|
1046
|
-
modeled:
|
|
1122
|
+
modeled:
|
|
1123
|
+
description: The production numbers are from our forecast
|
|
1124
|
+
type: boolean
|
|
1047
1125
|
operator: { $ref: '#/components/schemas/operator' }
|
|
1048
1126
|
prod_oil_bbl_day: { type: number }
|
|
1049
1127
|
prod_oil_bbl_month: { type: number }
|
|
1050
1128
|
prod_wet_gas_mcf_day: { type: number }
|
|
1051
1129
|
prod_wet_gas_mcf_month: { type: number }
|
|
1052
|
-
production_month: {
|
|
1130
|
+
production_month: { $ref: '#/components/schemas/production_month' }
|
|
1053
1131
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
1054
1132
|
state_code: { $ref: '#/components/schemas/state_code' }
|
|
1055
|
-
state_reported:
|
|
1133
|
+
state_reported:
|
|
1134
|
+
description: Has the state published any production numbers for this well
|
|
1135
|
+
type: boolean
|
|
1056
1136
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
|
|
1057
1137
|
well_id: { $ref: '#/components/schemas/well_id' }
|
|
1058
1138
|
ShortTermForecastResponse:
|
|
@@ -1080,7 +1160,7 @@ components:
|
|
|
1080
1160
|
county: { $ref: '#/components/schemas/county' }
|
|
1081
1161
|
date_forecast_run: { $ref: '#/components/schemas/date' }
|
|
1082
1162
|
date_prod: { $ref: '#/components/schemas/date' }
|
|
1083
|
-
operator: {
|
|
1163
|
+
operator: { $ref: '#/components/schemas/operator' }
|
|
1084
1164
|
prod_oil_bbl_day: { type: number }
|
|
1085
1165
|
prod_oil_bbl_month: { type: number }
|
|
1086
1166
|
prod_wet_gas_mcf_day: { type: number }
|
|
@@ -1094,7 +1174,7 @@ components:
|
|
|
1094
1174
|
properties:
|
|
1095
1175
|
date_frac_end: { $ref: '#/components/schemas/date' }
|
|
1096
1176
|
date_til: { $ref: '#/components/schemas/date' }
|
|
1097
|
-
operator: {
|
|
1177
|
+
operator: { $ref: '#/components/schemas/operator' }
|
|
1098
1178
|
prod_wet_gas_bcf_day: { type: number }
|
|
1099
1179
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
|
|
1100
1180
|
wellpad_id: { type: string }
|
|
@@ -1110,17 +1190,25 @@ components:
|
|
|
1110
1190
|
depth_measured: { type: number }
|
|
1111
1191
|
depth_tvd: { type: number }
|
|
1112
1192
|
horizontal_length: { type: number }
|
|
1113
|
-
lat_bottomhole:
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
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' }
|
|
1118
1206
|
region_natgas: { $ref: '#/components/schemas/region_natgas' }
|
|
1119
|
-
state_code: {
|
|
1207
|
+
state_code: { $ref: '#/components/schemas/state_code' }
|
|
1120
1208
|
sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
|
|
1121
1209
|
well_id: { $ref: '#/components/schemas/well_id' }
|
|
1122
1210
|
wellbore_type: { type: string }
|
|
1123
|
-
wellpad_id: {
|
|
1211
|
+
wellpad_id: { $ref: '#/components/schemas/wellpad_id' }
|
|
1124
1212
|
WellCompletionsResponse:
|
|
1125
1213
|
type: object
|
|
1126
1214
|
properties:
|
|
@@ -1143,8 +1231,10 @@ components:
|
|
|
1143
1231
|
aggregation_type:
|
|
1144
1232
|
type: string
|
|
1145
1233
|
example: sum
|
|
1234
|
+
description: The type of aggregation applied to data
|
|
1146
1235
|
enum: [ average, count, sum ]
|
|
1147
1236
|
completion_class:
|
|
1237
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1148
1238
|
type: string
|
|
1149
1239
|
example: oil
|
|
1150
1240
|
enum:
|
|
@@ -1152,23 +1242,28 @@ components:
|
|
|
1152
1242
|
- gas
|
|
1153
1243
|
- TBD
|
|
1154
1244
|
completion_class_array:
|
|
1245
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1155
1246
|
anyOf:
|
|
1156
1247
|
- type: array
|
|
1157
1248
|
items: { $ref: '#/components/schemas/completion_class' }
|
|
1158
1249
|
- $ref: '#/components/schemas/completion_class'
|
|
1159
1250
|
county:
|
|
1251
|
+
description: A county
|
|
1160
1252
|
type: string
|
|
1161
1253
|
example: CAMPBELL
|
|
1162
1254
|
county_array:
|
|
1255
|
+
description: A county
|
|
1163
1256
|
anyOf:
|
|
1164
1257
|
- type: array
|
|
1165
1258
|
items: { $ref: '#/components/schemas/county' }
|
|
1166
1259
|
- $ref: '#/components/schemas/county'
|
|
1167
1260
|
date:
|
|
1261
|
+
description: A date in YYYY-MM-DD format
|
|
1168
1262
|
type: string
|
|
1169
1263
|
format: date
|
|
1170
|
-
example:
|
|
1264
|
+
example: '2021-11-24'
|
|
1171
1265
|
frac_class:
|
|
1266
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1172
1267
|
type: string
|
|
1173
1268
|
example: oil
|
|
1174
1269
|
enum:
|
|
@@ -1176,6 +1271,7 @@ components:
|
|
|
1176
1271
|
- gas
|
|
1177
1272
|
- TBD
|
|
1178
1273
|
frac_class_array:
|
|
1274
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1179
1275
|
anyOf:
|
|
1180
1276
|
- type: array
|
|
1181
1277
|
items: { $ref: '#/components/schemas/frac_class' }
|
|
@@ -1186,40 +1282,49 @@ components:
|
|
|
1186
1282
|
items: { type: integer }
|
|
1187
1283
|
- type: integer
|
|
1188
1284
|
operator:
|
|
1285
|
+
description: A well operator
|
|
1189
1286
|
example: BILL BARRETT CORPORATION
|
|
1190
1287
|
type: string
|
|
1191
1288
|
operator_array:
|
|
1289
|
+
description: A well operator
|
|
1192
1290
|
anyOf:
|
|
1193
1291
|
- type: array
|
|
1194
1292
|
items: { $ref: '#/components/schemas/operator' }
|
|
1195
1293
|
- $ref: '#/components/schemas/operator'
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
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
|
|
1214
1316
|
region_natgas:
|
|
1317
|
+
description: Region divisions based on natural gas production profiles
|
|
1215
1318
|
example: west
|
|
1216
1319
|
type: string
|
|
1217
1320
|
region_natgas_array:
|
|
1321
|
+
description: Region divisions based on natural gas production profiles
|
|
1218
1322
|
anyOf:
|
|
1219
1323
|
- type: array
|
|
1220
1324
|
items: { $ref: '#/components/schemas/region_natgas' }
|
|
1221
1325
|
- $ref: '#/components/schemas/region_natgas'
|
|
1222
1326
|
rig_class:
|
|
1327
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1223
1328
|
type: string
|
|
1224
1329
|
example: oil
|
|
1225
1330
|
enum:
|
|
@@ -1227,14 +1332,17 @@ components:
|
|
|
1227
1332
|
- gas
|
|
1228
1333
|
- TBD
|
|
1229
1334
|
rig_class_array:
|
|
1335
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1230
1336
|
anyOf:
|
|
1231
1337
|
- type: array
|
|
1232
1338
|
items: { $ref: '#/components/schemas/rig_class' }
|
|
1233
1339
|
- $ref: '#/components/schemas/rig_class'
|
|
1234
1340
|
state_code:
|
|
1341
|
+
description: A state abbreviation
|
|
1235
1342
|
type: string
|
|
1236
1343
|
example: WY
|
|
1237
1344
|
state_code_array:
|
|
1345
|
+
description: Oil/Gas classification based on EIA-defined gas/oil production ratios
|
|
1238
1346
|
anyOf:
|
|
1239
1347
|
- type: array
|
|
1240
1348
|
items: { $ref: '#/components/schemas/state_code' }
|
|
@@ -1243,21 +1351,39 @@ components:
|
|
|
1243
1351
|
type: array
|
|
1244
1352
|
items: { type: string }
|
|
1245
1353
|
sub_region_natgas:
|
|
1354
|
+
description: Subregion divisions based on natural gas production profiles
|
|
1246
1355
|
type: string
|
|
1247
1356
|
example: Haynesville - TX
|
|
1248
1357
|
sub_region_natgas_array:
|
|
1358
|
+
description: Subregion divisions based on natural gas production profiles
|
|
1249
1359
|
anyOf:
|
|
1250
1360
|
- type: array
|
|
1251
1361
|
items: { $ref: '#/components/schemas/sub_region_natgas' }
|
|
1252
1362
|
- $ref: '#/components/schemas/sub_region_natgas'
|
|
1363
|
+
well_id:
|
|
1364
|
+
description: A well identifier
|
|
1365
|
+
type: string
|
|
1366
|
+
example: 4900552885
|
|
1253
1367
|
well_id_array:
|
|
1368
|
+
description: Subregion divisions based on natural gas production profiles
|
|
1254
1369
|
anyOf:
|
|
1255
1370
|
- type: array
|
|
1256
1371
|
items: { $ref: '#/components/schemas/well_id' }
|
|
1257
1372
|
- $ref: '#/components/schemas/well_id'
|
|
1258
|
-
|
|
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:
|
|
1259
1382
|
type: string
|
|
1260
|
-
example:
|
|
1383
|
+
example: Drilling
|
|
1384
|
+
enum:
|
|
1385
|
+
- Drilling
|
|
1386
|
+
- Fracking
|
|
1261
1387
|
CompleteReportDateReponse:
|
|
1262
1388
|
type: object
|
|
1263
1389
|
properties:
|
|
@@ -1278,3 +1404,15 @@ components:
|
|
|
1278
1404
|
type: string
|
|
1279
1405
|
format: date
|
|
1280
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' }
|
|
File without changes
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
import sys
|
|
3
|
+
import os
|
|
4
|
+
import logging
|
|
5
|
+
from synmax.openapi.client import OpenAPIClient
|
|
6
|
+
from typing import Optional, Dict
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
current_dir = os.path.dirname(__file__)
|
|
11
|
+
|
|
12
|
+
logger = logging.getLogger(__name__)
|
|
13
|
+
handler = logging.StreamHandler(sys.stdout)
|
|
14
|
+
formatter = logging.Formatter(f'%(levelname)s {__name__} - %(message)s')
|
|
15
|
+
handler.setFormatter(formatter)
|
|
16
|
+
logger.addHandler(handler)
|
|
17
|
+
|
|
18
|
+
class LeviatonApiClient(OpenAPIClient):
|
|
19
|
+
_spec = os.path.join(current_dir, "openapi.yaml")
|
|
20
|
+
|
|
21
|
+
def __init__(self,
|
|
22
|
+
access_token: str,
|
|
23
|
+
base_uri: str = "https://leviaton.api.synmax.com/v1/",
|
|
24
|
+
timeout = 30.0,
|
|
25
|
+
retries = 3,
|
|
26
|
+
retry_sleep = 30,
|
|
27
|
+
):
|
|
28
|
+
|
|
29
|
+
super().__init__(
|
|
30
|
+
base_uri,
|
|
31
|
+
headers={
|
|
32
|
+
"Access-Key": access_token,
|
|
33
|
+
},
|
|
34
|
+
logger=logger,
|
|
35
|
+
timeout=timeout,
|
|
36
|
+
)
|