synmax-api-python-client 4.14.0__py3-none-any.whl → 4.16.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.
@@ -56,6 +56,9 @@ class HyperionApiClient:
56
56
  def fetch_tils(self) -> Result:
57
57
  """TIL monitoring data."""
58
58
  ...
59
+ def fetch_tils_expanded(self) -> Result:
60
+ """Expanded TIL monitoring data."""
61
+ ...
59
62
  def wells(self,aggregate_by: list[Literal['county', 'date_first_production', 'date_spud', 'operator', 'region_natgas', 'state_code', 'sub_region_natgas', 'produced_formation', 'produced_basin']] = ...,county: Union[list[str], str] = ...,date_spud_min: Any = ...,date_spud_max: Any = ...,date_first_production_min: Any = ...,date_first_production_max: Any = ...,depth_min: float = ...,depth_max: float = ...,horizontal_length_min: float = ...,horizontal_length_max: float = ...,lat_surface_min: float = ...,lat_surface_max: float = ...,lon_surface_min: float = ...,lon_surface_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] = ...,produced_formation: Union[list[str], str] = ...,produced_basin: Union[list[str], str] = ...,response_fields: list[str] = ...) -> Result:
60
63
  """Well level details. Well level data derived from all sources."""
61
64
  ...
@@ -777,6 +777,19 @@ paths:
777
777
  schema: { $ref: '#/components/schemas/TilsResponse' }
778
778
  application/x-ndjson:
779
779
  schema: { $ref: '#/components/schemas/TilsResponse' }
780
+ /tilsexpanded:
781
+ get:
782
+ x-method-name: fetch_tils_expanded
783
+ summary: Expanded TIL monitoring data.
784
+ security: [ApiKeyAuth: [dtil_expansion]]
785
+ responses:
786
+ '200':
787
+ description: Success
788
+ content:
789
+ application/json:
790
+ schema: { $ref: '#/components/schemas/TilsExpandedResponse' }
791
+ application/x-ndjson:
792
+ schema: { $ref: '#/components/schemas/TilsExpandedResponse' }
780
793
  /wells:
781
794
  post:
782
795
  x-method-name: wells
@@ -1785,6 +1798,22 @@ components:
1785
1798
  sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1786
1799
  wellpad_id: { type: string, description: "The unique identifier for the wellpad" }
1787
1800
  wells: { type: integer, description: "The number of wells" }
1801
+ TilsExpandedResponse:
1802
+ type: object
1803
+ properties:
1804
+ date_frac_end:
1805
+ allOf:
1806
+ - $ref: '#/components/schemas/date'
1807
+ description: The date observed via satellite that the well crew completed fracking in YYYY-MM-DD format
1808
+ date_til:
1809
+ allOf:
1810
+ - $ref: '#/components/schemas/date'
1811
+ description: Expected TIL date in YYYY-MM-DD format
1812
+ operator: { $ref: '#/components/schemas/operator' }
1813
+ prod_wet_gas_bcf_day: { type: number, description: "Daily wet gas production in billion cubic feet" }
1814
+ sub_region_natgas: { $ref: '#/components/schemas/sub_region_natgas' }
1815
+ wellpad_id: { type: string, description: "The unique identifier for the wellpad" }
1816
+ wells: { type: integer, description: "The number of wells" }
1788
1817
  TransactionsResponse:
1789
1818
  type: object
1790
1819
  properties:
@@ -15,9 +15,13 @@ from synmax.hyperion.v4 import HyperionApiClient
15
15
 
16
16
  SYNMAX_ACCESS_TOKEN = "eyJwcm9qZWN0X2lkIjogIlN5bm1heCBjb21tZXJjaWFsIEFQSSIsICJwcml2YXRlX2tleSI6ICIwQndzX0ExMFpkdVQyaWlNLS1lbXh3Mk5BNUkxa09kdFNVai04RjVvNzU4IiwgImNsaWVudF9pZCI6ICJGZWxpeCBLZXkiLCAidHlwZSI6ICJvbmVfeWVhcl9saWNlbnNlZF9jdXN0b21lciIsICJzdGFydF9kYXRlIjogIjAzLzE5LzIwMjQiLCAiZW5kX2RhdGUiOiAiMDMvMTkvMjAyNSIsICJ0cmlhbF9saWNlbnNlIjogZmFsc2UsICJpc3N1ZV9kYXRldGltZSI6ICIxOS0wMy0yMDI0IDE0OjI0OjA4IiwgImFkbWluX3VzZXIiOiBmYWxzZSwgInVzZXJfcm9sZXMiOiBbImh5cGVyaW9uIiwgInZ1bGNhbiJdfQ=="
17
17
  hyperion_api_client = HyperionApiClient(access_token=SYNMAX_ACCESS_TOKEN)
18
-
19
- wells_resp = hyperion_api_client.wells(response_fields=["county", "date_completion", "date_first_production", "date_permit", "date_spud", "depth_measured", "depth_tvd", "horizontal_length", "lat_bottomhole", "lon_bottomhole", "lat_surface", "lon_surface", "operator", "region_natgas", "state_code", "sub_region_natgas", "well_id", "wellbore_type", "wellpad_id", "produced_formation", "produced_basin"], date_first_production_min="2023-01-31", date_first_production_max="2024-09-01")
20
-
21
- wells_df = wells_resp.df()
22
- wells_df.head()
23
- print(wells_df)
18
+ hyperion_api_client._write_stub()
19
+
20
+ # wells_resp = hyperion_api_client.wells(response_fields=["county", "date_completion", "date_first_production", "date_permit", "date_spud", "depth_measured", "depth_tvd", "horizontal_length", "lat_bottomhole", "lon_bottomhole", "lat_surface", "lon_surface", "operator", "region_natgas", "state_code", "sub_region_natgas", "well_id", "wellbore_type", "wellpad_id", "produced_formation", "produced_basin"], date_first_production_min="2023-01-31", date_first_production_max="2024-09-01")
21
+ results = hyperion_api_client.fetch_tils_expanded()
22
+ results_df = results.df()
23
+ results_df.head()
24
+ print(results_df)
25
+ # wells_df = wells_resp.df()
26
+ # wells_df.head()
27
+ # print(wells_df)
@@ -197,12 +197,34 @@ paths:
197
197
  content:
198
198
  application/json:
199
199
  schema: { $ref: '#/components/schemas/ErrorResponse' }
200
+
201
+ /infrastructure_watch_extended:
202
+ get:
203
+ operationId: routes.v2.infrastructure_watch_extended.get
204
+ x-method-name: infrastructure_watch_extended
205
+ summary: Get infrastructure watch extended data (Middle East conflict)
206
+ security: [ApiKeyAuth: [vulcan_infrastructure_watch_extended]]
207
+ responses:
208
+ '200':
209
+ description: Infrastructure watch extended data
210
+ content:
211
+ application/json:
212
+ schema:
213
+ type: array
214
+ items:
215
+ $ref: '#/components/schemas/InfrastructureWatchExtendedResponse'
216
+ '500':
217
+ description: Internal Server Error - Database error
218
+ content:
219
+ application/json:
220
+ schema: { $ref: '#/components/schemas/ErrorResponse' }
221
+
200
222
  /beta/query_datalinks:
201
223
  post:
202
224
  x-method-name: beta_query_datalinks
203
225
  security: [ApiKeyAuth: [hyperion]]
204
226
  summary: Execute SQL queries against SynMax datalinks
205
- description: Execute T-SQL queries directly against SynMax's 5 datalinks (19 tables). Returns query results as structured data.
227
+ description: Execute T-SQL queries directly against SynMax's datalinks. Returns query results as structured data.
206
228
  requestBody:
207
229
  required: true
208
230
  content:
@@ -215,7 +237,7 @@ paths:
215
237
  query:
216
238
  type: string
217
239
  description: SQL query to execute. Tables must use {linkid}_{table} format. Use ANSI SQL (LIMIT not TOP).
218
- example: "SELECT * FROM 1005_v_pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
240
+ example: "SELECT * FROM v_pipeline_flow WHERE gas_day >= '2024-01-01' LIMIT 100"
219
241
  session_id:
220
242
  type: string
221
243
  description: Optional session ID for logging/tracking. Auto-generated if not provided.
@@ -479,6 +501,11 @@ components:
479
501
  description: ISO date on which the record was created
480
502
  example: "2023-01-01T12:00:00Z"
481
503
  nullable: true
504
+ btm_generation:
505
+ type: boolean
506
+ description: Indicates if the data center has behind-the-meter generation
507
+ example: true
508
+ nullable: true
482
509
  required:
483
510
  - synmax_id
484
511
 
@@ -662,6 +689,11 @@ components:
662
689
  example: "4/14/2025"
663
690
  description: Date of the latest available satellite image
664
691
  nullable: true
692
+ county:
693
+ type: string
694
+ example: "Fayette"
695
+ description: Plant county - Provided by EIA
696
+ nullable: true
665
697
  latitude:
666
698
  type: number
667
699
  format: float
@@ -1379,6 +1411,100 @@ components:
1379
1411
  example: "2025-11-17"
1380
1412
  description: ISO date on which the record was last modified
1381
1413
  nullable: true
1414
+
1415
+ InfrastructureWatchExtendedResponse:
1416
+ type: object
1417
+ properties:
1418
+ site_id:
1419
+ type: string
1420
+ format: uuid
1421
+ example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"
1422
+ description: Unique UUID identifying the infrastructure site.
1423
+ nullable: false
1424
+ site_name:
1425
+ type: string
1426
+ example: "South Pars"
1427
+ description: Name of the tracked infrastructure site.
1428
+ nullable: false
1429
+ vulcan_assessment:
1430
+ type: string
1431
+ example: "visual change"
1432
+ description: The latest visual or operational assessment of the site (e.g., no change, visual change).
1433
+ nullable: false
1434
+ vulcan_assessment_datetime:
1435
+ type: string
1436
+ format: date-time
1437
+ example: "2026-03-05T20:00:00Z"
1438
+ description: ISO-8601 timestamp of when the assessment was conducted.
1439
+ nullable: false
1440
+ additional_notes:
1441
+ type: string
1442
+ example: "site fires and scarring detected near LNG trains"
1443
+ description: Additional context or observations regarding the assessment.
1444
+ nullable: true
1445
+ country:
1446
+ type: string
1447
+ example: "Iran"
1448
+ description: Country where the infrastructure is located.
1449
+ nullable: false
1450
+ country_code:
1451
+ type: string
1452
+ example: "IR"
1453
+ description: ISO country code of the location.
1454
+ nullable: false
1455
+ technology:
1456
+ type: string
1457
+ example: "Oil/Gas Processing"
1458
+ description: The primary industry or technology type of the site.
1459
+ nullable: true
1460
+ capacity:
1461
+ type: number
1462
+ format: float
1463
+ example: 730.0
1464
+ description: Operational capacity of the infrastructure.
1465
+ nullable: true
1466
+ capacity_unit:
1467
+ type: string
1468
+ example: "MMcm/d"
1469
+ description: Unit of measurement for the capacity.
1470
+ nullable: true
1471
+ latitude:
1472
+ type: number
1473
+ format: double
1474
+ example: 27.508
1475
+ description: Latitude of the site in decimal degrees.
1476
+ nullable: false
1477
+ longitude:
1478
+ type: number
1479
+ format: double
1480
+ example: 52.575
1481
+ description: Longitude of the site in decimal degrees.
1482
+ nullable: false
1483
+ location_wkt:
1484
+ type: string
1485
+ example: "POINT(52.575 27.508)"
1486
+ description: Well-Known Text (WKT) spatial representation of the site coordinates (Longitude Latitude).
1487
+ nullable: false
1488
+ image_benchmark_datetime:
1489
+ type: string
1490
+ format: date-time
1491
+ example: "2026-03-05T21:00:00Z"
1492
+ description: ISO-8601 timestamp of the baseline image used for comparison.
1493
+ nullable: true
1494
+ image_acquisition_datetime:
1495
+ type: string
1496
+ format: date-time
1497
+ example: "2026-03-05T20:00:00Z"
1498
+ description: ISO-8601 timestamp of when the newest satellite image was acquired.
1499
+ nullable: true
1500
+ image_source:
1501
+ type: string
1502
+ example: "Planet"
1503
+ description: Provider of the satellite imagery.
1504
+ nullable: true
1505
+ image_resolution:
1506
+ type: string
1507
+ example: "10m"
1382
1508
 
1383
1509
  ErrorResponse:
1384
1510
  type: object
@@ -11,17 +11,18 @@ claims_dict = {
11
11
  {"claim_name": "vulcan_lng_projects", "claim_json": {"name": "vulcan_lng_projects", "type": "api", "filters": {}}},
12
12
  {"claim_name": "vulcan_metadata_history", "claim_json": {"name": "vulcan_metadata_history", "type": "api", "filters": {}}},
13
13
  {"claim_name": "vulcan_project_rankings", "claim_json": {"name": "vulcan_project_rankings", "type": "api", "filters": {}}},
14
+ {"claim_name": "vulcan_iir_data", "claim_json": {"name": "vulcan_iir_data", "type": "api", "filters": {}}},
15
+ {"claim_name": "vulcan_infrastructure_watch_extended", "claim_json": {"name": "vulcan_infrastructure_watch_extended", "type": "api", "filters": {}}},
14
16
  ]
15
17
  }
16
18
 
17
- client = VulcanApiClient(access_token='PSq8zWS3FgHnVGcE2Yz4ZNOBk4SRpUPI')
19
+ client = VulcanApiClient(access_token='eyJwcm9qZWN0X2lkIjogIlN5bm1heCBjb21tZXJjaWFsIEFQSSIsICJwcml2YXRlX2tleSI6ICIwQndzX0ExMFpkdVQyaWlNLS1lbXh3Mk5BNUkxa09kdFNVai04RjVvNzU4IiwgImNsaWVudF9pZCI6ICJGZWxpeCBLZXkiLCAidHlwZSI6ICJvbmVfeWVhcl9saWNlbnNlZF9jdXN0b21lciIsICJzdGFydF9kYXRlIjogIjAzLzE5LzIwMjQiLCAiZW5kX2RhdGUiOiAiMDMvMTkvMjAyNSIsICJ0cmlhbF9saWNlbnNlIjogZmFsc2UsICJpc3N1ZV9kYXRldGltZSI6ICIxOS0wMy0yMDI0IDE0OjI0OjA4IiwgImFkbWluX3VzZXIiOiBmYWxzZSwgInVzZXJfcm9sZXMiOiBbImh5cGVyaW9uIiwgInZ1bGNhbiJdfQ==')
18
20
 
19
21
 
20
22
  payload = {}
21
23
 
22
- got = client.lng_projects()
24
+ got = client.infrastructure_watch_extended()
23
25
  df = got.df()
24
26
  print(df)
25
27
 
26
- print(got)
27
- breakpoint()
28
+ print(got)
@@ -23,6 +23,9 @@ class VulcanApiClient:
23
23
  def iir_data(self) -> Result:
24
24
  """Get IIR data"""
25
25
  ...
26
+ def infrastructure_watch_extended(self) -> Result:
27
+ """Get infrastructure watch extended data (Middle East conflict)"""
28
+ ...
26
29
  def beta_query_datalinks(self,query: str,session_id: str = ...) -> Result:
27
30
  """Execute SQL queries against SynMax datalinks"""
28
31
  ...
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: synmax-api-python-client
3
- Version: 4.14.0
3
+ Version: 4.16.0
4
4
  Summary: Synmax API client
5
5
  Home-page: https://github.com/SynMaxDev/synmax-api-python-client.git
6
6
  Author: SynMax Inc.
@@ -15,9 +15,9 @@ synmax/hyperion/process_api.py,sha256=y3sNiM2X_h-QVRRsrW4VmkABfGKxPqqZGMiYNrpRrK
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
17
  synmax/hyperion/v4/hyperion_client.py,sha256=mhYL3QiOoD2viCI60grLMFvGdHx8iD8IF05NWC6-HS0,868
18
- synmax/hyperion/v4/hyperion_client.pyi,sha256=9yfaspyAiPCiSDWNTkOpkHafCevLqyhGokwnN1DQ_Po,11938
19
- synmax/hyperion/v4/openapi.yaml,sha256=iTCcWfzBT9DT7ZbMEWS4WLnrmmlMf77Zuyv8FXSVDtw,98989
20
- synmax/hyperion/v4/start_hyperion_client.py,sha256=R9NvCfqWriXk2awJ0pmmDfEXTKn0QaGaDai9JLGyyGE,2340
18
+ synmax/hyperion/v4/hyperion_client.pyi,sha256=yNgEmWzZWKPeQ4Y-ilfBOr8e_lMD4GIMwWe3UCHu438,12039
19
+ synmax/hyperion/v4/openapi.yaml,sha256=RU4mACjWtL3yNwN5tEyZHYcJ37-pg7F3Y84UyBDfveE,100266
20
+ synmax/hyperion/v4/start_hyperion_client.py,sha256=0Cs6qgy8yYuhrVhSVZqa7TKKR9PHFkEomA26MTQUJlU,2495
21
21
  synmax/leviaton/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
22
22
  synmax/leviaton/start_leviaton_client.py,sha256=XrgEHoYTsLgwyuBWkHxsCzeEGoj4C40RuDVD_0QZ_ks,4101
23
23
  synmax/leviaton/start_leviaton_client2.py,sha256=JdN0FJV67yqjptxw769CjRqgFdzqIdCvmpNclmnErzg,3107
@@ -32,18 +32,18 @@ synmax/theia/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
32
32
  synmax/vulcan/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
33
33
  synmax/vulcan/start_vulcan_python_client.py,sha256=cx4DQyrNpIR6UyzOdEFreZWVLCwHE1Z1II5dfN6SPMg,746
34
34
  synmax/vulcan/v2/__init__.py,sha256=AGMAxDs93mZ_9zF1fFAufUsu9w9Ep94lO1vbLGbD-LU,81
35
- synmax/vulcan/v2/openapi.yaml,sha256=AkSc97bLX9hdR3OSSJqH_hF1TDCP7oghUk1uTsSmPNo,48866
36
- synmax/vulcan/v2/start_vulcan_client.py,sha256=XWHXzwCu6gK33Pw0FKfGjwXiEadg-G6VQI5UsqBlVHc,1002
35
+ synmax/vulcan/v2/openapi.yaml,sha256=NzIGFtgqH5fd7ekSjXoTl6aQAkt2Fjk2kDaqDj-0z9M,53272
36
+ synmax/vulcan/v2/start_vulcan_client.py,sha256=KaCH0B71-d5Px1BUizgV5NEQk_zBmXl_3ejq79WaKcg,1708
37
37
  synmax/vulcan/v2/start_vulcan_client2.py,sha256=z59_ZLZ3NX7nO-50cEx7bqeuzYRj-pA4WEMlLf304qs,1833
38
38
  synmax/vulcan/v2/vulcan_client.py,sha256=aeCaISqNyJ0bezbvCcxVgdGmUPp2Lv0SFqDbFCt9TXQ,879
39
- synmax/vulcan/v2/vulcan_client.pyi,sha256=N8hgva9k2xdIikxnaZwsAPNb_S_ve_UVgpxfrHl7Od4,1120
39
+ synmax/vulcan/v2/vulcan_client.pyi,sha256=PwWS5qexlEWzwF3oK0N7_mgCP1ne8PFSwrlWyCd5b00,1263
40
40
  test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
41
41
  test/test_api_client.py,sha256=HFWCu_xBgqQXc9p6k6YmP2gVrdCFwuhoDVqlxpN1Yoc,4713
42
42
  test/test_hyperion_client.py,sha256=aCb4bMBXWofa82MInXoU9tJ5wWsg5sBRv7B_CHvkrcg,1380
43
43
  test/test_hyperion_e2e.py,sha256=BPhZH7eVQZSsFcvPdonKjmLahnfsLy37Z2DHp0LGeHc,6247
44
44
  test/test_hyperion_helpers.py,sha256=R0G7oqKaoz6jLRACODJ1Cf2gA0gaMPQhOZRjKp4a6-s,2006
45
- synmax_api_python_client-4.14.0.dist-info/LICENSE,sha256=vKvn9cDVfJhNepCuIXLWaHnnUoDPX26KD-iWb7NAZ4M,44
46
- synmax_api_python_client-4.14.0.dist-info/METADATA,sha256=IYxcI2IOhWJxnfvvLEwwb0_HbuBSpTABZXVtfz5YgqI,4994
47
- synmax_api_python_client-4.14.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
48
- synmax_api_python_client-4.14.0.dist-info/top_level.txt,sha256=SAjmDfHlJzUmjoGCT1SnS4qGSLN_ZF-p58UN1yW5kB0,17
49
- synmax_api_python_client-4.14.0.dist-info/RECORD,,
45
+ synmax_api_python_client-4.16.0.dist-info/LICENSE,sha256=vKvn9cDVfJhNepCuIXLWaHnnUoDPX26KD-iWb7NAZ4M,44
46
+ synmax_api_python_client-4.16.0.dist-info/METADATA,sha256=8mwiRFK5IHJfXhnkIXJ2FT0JzTYeuPohhSQQBIKax_M,4994
47
+ synmax_api_python_client-4.16.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
48
+ synmax_api_python_client-4.16.0.dist-info/top_level.txt,sha256=SAjmDfHlJzUmjoGCT1SnS4qGSLN_ZF-p58UN1yW5kB0,17
49
+ synmax_api_python_client-4.16.0.dist-info/RECORD,,