/pipelinescrapestatus#
The Pipeline Scrape Status endpoint provides a system status overview for pipeline flow data. It provides insights into the percentage of points that have been posted and the distribution of these points across different nomination cycles.
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/pipelinescrapestatus |
Usage#
Python#
- client.fetch_pipeline_scrape_status()#
Returns system status and distribution metrics for pipeline flow data.
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 |
|---|---|---|---|
date |
string |
Date of observation. Date formatting - [“YYYY-MM-DD”] |
“2022-06-01” |
id1_pct |
float |
Percentage of points reported in nomination cycle 1 out of the total points. |
66.59824594140697 |
id2_pct |
float |
Percentage of points reported in nomination cycle 2 out of the total points. |
18.585557006904274 |
id3_pct |
float |
Percentage of points reported in nomination cycle 3 out of the total points. |
9.087516327673073 |
other_pct |
float |
Covers the percentage of points falling under unclassified cycles, not specifically categorized in the other defined cycles (ID1, ID2, ID3, Timely). |
1.2129128568762866 |
points_reporting_pct |
integer |
Percentage of points that have been posted for each gas day. |
100 |
timely_pct |
float |
Percentage of ‘timely’ points, usually reported in the very first cycle, out of the total points. |
4.515767867139392 |
Responses#
Normal Output#
date |
id1_pct |
id2_pct |
id3_pct |
other_pct |
points_reporting_pct |
timely_pct |
|---|---|---|---|---|---|---|
2024-01-27 |
0 |
5.056913603284195 |
86.21011382720657 |
4.217204702369841 |
100 |
4.515767867139392 |
2024-01-28 |
66.59824594140697 |
18.585557006904274 |
9.087516327673073 |
1.2129128568762866 |
100 |
4.515767867139392 |
2024-01-29 |
0 |
0 |
0 |
0 |
3.284194812465012 |
100 |
Note
Output data will return as “null” when input data is invalid or does not exist.