/pipelinescrapes#

This endpoint provides daily updates on various aspects of pipeline activity, focusing on gas production. It offers detailed information about pipeline production in various regions, with a focus on specific locations and pipeline entities.

This endpoint is particularly useful for tracking energy production, monitoring pipeline activities, and analyzing regional energy trends.

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#

POST

https://hyperion.api.synmax.com/v3/pipelinescrapes

Usage#

Python#

pipeline_scrapes(category=[None], county=[None], end_date=None, rec_del=[None], region=[None], start_date=None, state_code=[None], sub_region=[None])#

Returns daily pipeline scrapes.

Object returned is a pandas DataFrame.

⮞ Setup the client.

from synmax.hyperion import HyperionApiClient, ApiPayload
access_token = 'your access token goes here'
client = HyperionApiClient(access_token=access_token)

For a more detailed guide on setting up the Hyperion client, please see the Quickstart page.

⮞ Use parameters to narrow down your request.

payload = ApiPayload(start_date='2021-05-01', end_date='2022-06-25', sub_region=['S LA', 'West - TX'])

Tip

Narrow down your request to receive a faster response. Using no parameters will fetch the entire dataset which may take a very long time.

⮞ Call the function.

result_df = client.pipeline_scrapes(payload)

⮞ Print the results or save them for later.

# Print the entire response as a string.
print(result_df.to_string())

# Create a CSV file from the output.
result_df.to_csv('output.csv')

# Print the number of items per column.
print(result_df.count())

For more information on outputting to different formats, please see the pandas DataFrame documentation.

Parameters#

Query#

Parameter	Type	Description	Example
category	string array	Limit search to a type of flow point as described by the pipelines informational posting location data disclosure.	`["Production"]`
county	string array	Limit search by a list of counties.	`["Beauregard", "Coleman", "Colorado"]`
end_date	string	Limit search to an end date. Date formatting - [“YYYY-MM-DD”]	`"2022-07-15"`
rec_del	integer array	Limit search by Receipt or Delivery Point. `1` represents a Receipt Point, i.e. gas flowing into the pipe, whereas `-1` represents Delivery Point, i.e. gas flowing out of the pipe. `0` represents data that is unavailable.	`[-1,0,1]`
region	string array	Limit search by a list of regions (clusters of multiple major producing basins).	`["GULF", "WEST"]`
start_date	string	Limit search to a start date. Date formatting - [“YYYY-MM-DD”]	`"2022-06-01"`
state_code	string array	Limit search by a list of state codes.	`["LA", "CO"]`
sub_region	string array	Limit search by a list of subregions (clusters of several counties forming a major producing basin).	`["S LA", "West - TX"]`

Response#

Parameter	Type	Description	Example
category	string	Limit search to a type of flow point as described by the pipelines informational posting location data disclosure.	“Production”
county	string	County in the state where the well is located.	“BEAUREGARD”
date	string	Date of observation. Date formatting - [“YYYY-MM-DD”]	“2022-06-01”
gas_daily	float	Average rate of gas production expressed per day (in BCF/day).	23.842
id	integer	A SynMax assigned unique ID for each flow point.	1
location_name	string	Name of the flow point as provided by the pipeline’s information posting disclosure.	“TIOGA”
pipeline_name	string	Name of pipeline as provided by FERC.	“Alliance Pipeline L.P.”
rec_del	integer	Represents Receipt or Delivery Point. `1` represents a Receipt Point, i.e. gas flowing into the pipe, whereas `-1` represents Delivery Point, i.e. gas flowing out of the pipe. `0` represents data that is unavailable.	1
region	string	Aggregation of multiple major producing basins.	“GULF”
source	string	Indicates the origin or method of data collection for the pipeline information provided by the API. Returned values are either “scrape” for webscraped values, “ffill” for forward filled values.	“scrape”
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#

category	county	date	gas_daily	id	location_name	pipeline_name	rec_del	region	source	state_ab	sub_region
Production	WILLIAMS (ND)	01-05-2023	91253	1	TIOGA	Alliance Pipeline L.P.	1	midwest	scrape	ND	North Dakota
Production	DEWEY (OK)	01-06-2022	0	2	ANR/GPM INT-HAMMER RAY	ANR Pipeline Company	1	midwest	scrape	OK	OK
Production	ST. LANDRY (LA)	01-07-2022	0	5	OLIVER BENOIT 1 WELLS	ANR Pipeline Company	1	gulf	scrape	LA	S LA
Production	ROBERTS (TX)	01-01-2023	0	6	ROBERTS EAGLE ROCK	ANR Pipeline Company	1	gulf	scrape	TX	North - TX
Production	HARPER (OK)	01-06-2022	0	10	SEMINOLE-LOVEDALE	ANR Pipeline Company	1	midwest	scrape	OK	OK
Production	HANSFORD (TX)	01-01-2023	0	13	SHERMAN PLANT	ANR Pipeline Company	1	gulf	scrape	TX	North - TX
Production	JEFFERSON DAVIS (LA)	01-07-2022	2600	14	WEST LAKE ARTHUR	ANR Pipeline Company	1	gulf	scrape	LA	S LA
Production	WELD (CO)	22-06-2023	35474	19	SUMMIDJO/CPG (MKN) MAKENA REC WELD	CHEYENNE PLAINS GAS PIPELINE	1	west	scrape	CO	Colorado wo SJ
Production	BEAVER (OK)	23-09-2023		20	Baldwin 1	Cimarron River Pipeline LLC	1	midwest	ffill	OK	OK

Note

Output data will return as “null” when input data is invalid or does not exist.

/operatorclassification

/pipelinescrapestatus