/regions#
This endpoint returns data on regions.
Warning
A throttling mechanism with a rate limit of 300 requests per minute has been implemented for this endpoint. This is temporary and may be adjusted in the future.
Endpoint#
GET |
https://hyperion.api.synmax.com/v3/regions |
Usage#
Python#
- client.fetch_regions()#
Returns data county, subregion, region, and state.
This function takes no parameters.
Object returned is a pandas DataFrame.
Note
To learn how to setup and use Python client, refer to Setup and Usage .
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
county |
string |
County in the state where the well is located. |
“BEAUREGARD” |
region |
string |
Aggregation of multiple major producing basins. |
“GULF” |
state_ab |
string |
Abbreviation of the state. |
“LA” |
sub_region |
string |
Aggregation of several counties, typically representing a major producing basin. |
“S LA” |
Responses#
Normal Output#
county |
region |
state_ab |
sub_region |
|---|---|---|---|
southeast |
AL |
||
midwest |
AR |
||
west |
AZ |
||
west |
CA |
||
west |
CO |
||
northeast |
CT |
||
northeast |
DC |
||
northeast |
DE |
||
southeast |
FL |
||
gulf |
FO GULF |
Note
Output data will return as “null” when input data is invalid or does not exist.