PipeRivCapacity
The operationally available capacity endpoint is private and requires Premium API access.
GET /ip/capacity/{pipeline_slug}
Private endpoint. Provides the capacity list for the operationally available capacity.
Query Arguments
example: /ip/capacity/texas-eastern?cycle=timely&gas_day=2025-01-15
pipeline_slug: string
This field will filter the results to a specific pipeline. The slug of the pipeline should be used in this argument.
cycle: string (optional)
This field will filter the results to a specific cycle. The arguments that can be passed in for this field are:
- latest (default): Displays the latest available cycle results.
- timely: Displays the Timely cycle results.
- evening: Displays the Evening cycle results.
- id1: Displays the Intraday 1 cycle results.
- id2: Displays the Intraday 2 cycle results.
- id3: Displays the Intraday 3 cycle results.
gas_day: date (optional) (format: YYYY-MM-DD)
This field will filter the results to a specific gas day.
Result Values
cycle.id: integer
The PipeRiv id and primary key in the database for the cycle. This value will be unique to the cycle.
cycle.pipeline_id: integer
The id of the pipline. This is the same id that is listed when you call the `pipelines` API results.
cycle.pipeline_name: short string
The name of the pipline.
cycle.pipeline_slug: short string
The slug of the pipline.
cycle.pipeline_url: short string
The URL of the pipline's informational postings.
cycle.identifier: short string
The id of the cycle used by the pipeline. This value may not be unique across pipelines.
cycle.cycle: short string
The cycle type (latest, timely, evening, id1, id2, or id3).
cycle.gas_day: date
The gas day for the cycle.
cycle.piperiv_created_at: datetime
The date and time the cycle was added to the PipeRiv system using the UTC timezone.
cycle.piperiv_updated_at: datetime
The date and time the cycle was updated on the PipeRiv system using the UTC timezone.
locations.id: integer
The PipeRiv id and primary key in the database for the location capacity entry. This value will be unique to the capacities.
locations.location: short string
The name of the location.
locations.identifier: short string
The id of the location used by the pipeline.
locations.flow: short string
The flow direction of the capacity entry.
locations.qti: short string
The QTI (Quantity Type Indicator) for the location.
locations.zone: short string
The zone where the location is located.
locations.dc: short string
The Design Capacity for the location.
locations.opc: short string
The Operating Capacity for the location.
locations.tsq: short string
The Total Scheduled Quantity for the location.
locations.oac: short string
The Operationally Available Capacity for the location.
locations.it: short string
The IT (Interruptible Transportation) for the location.
locations.all: short string
Whether or not all quantity is available.
locations.reason: long text
Provides additional notes for the entry.
piperiv_created_at: datetime
The date and time the capacity data was added to the PipeRiv system using the UTC timezone.
piperiv_updated_at: datetime
The date and time the capacity data was updated on the PipeRiv system using the UTC timezone.
Available Pipelines (20 pipelines)
- Algonquin (AGT) - algonquin
- Columbia Gas (TCO) - columbia
- Columbia Gulf - columbia-gulf
- Cove Point LNG - cove-point
- Eastern Gas Transmission - eastern-gas
- Equitrans - equitrans
- Great Lakes Gas Transmission - great-lakes
- Gulf South - gulf-south
- Iroquois - iroquois
- Maritimes and Northeast Pipeline - maritimes
- Millennium - millennium
- National Fuel (Empire) - empire
- National Fuel (Supply Corp) - national-fuel
- Nexus - nexus-gas
- Rockies Express - rockies-express (still in beta)
- Rover - rover
- Tennessee - tennessee
- Texas Eastern - texas-eastern
- Texas Gas - texas-gas
- Transco - transco
Endpoint Example
Below is a live example that can be copy and pasted.
curl "https://www.piperiv.com/api/v1/ip/capacity/texas-eastern?cycle=timely&gas_day=2025-01-15" -u "demo:pr_api_live_01234demo56789_key"
Below is the expected result from that cURL call:
{
"status": "success",
"messages": [
"The demo account has access to limited data and can only view Texas Eastern Transmission data for the day of 2025-01-15."
],
"meta": {
"total_locations": 878
},
"data": {
"cycle": {
"id": 13536,
"pipeline_id": 51,
"pipeline_name": "Texas Eastern Transmission",
"pipeline_slug": "texas-eastern",
"pipeline_url": "https://infopost.enbridge.com/infopost/TEHome.asp?Pipe=TE",
"identifier": "TIMELY_2025-01-14_1511",
"cycle": "timely",
"gas_day": "2025-01-15",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-16 15:40:13"
},
"locations": [
{
"id": 11546826,
"location": "Dominion Energy Transmission, Inc - Clarington, OH",
"identifier": "70004",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 585284,
"opc": 590644,
"tsq": 99709,
"oac": 490935,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-14 21:56:10"
},
{
"id": 11546827,
"location": "Columbia Gas of PA. - Eagle, PA",
"identifier": "70011",
"flow": "D",
"qti": "DPQ",
"zone": "3",
"dc": 291789,
"opc": 444405,
"tsq": 122879,
"oac": 321526,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-14 21:56:10"
},
{
"id": 11546828,
"location": "Indiana Gas - Greensburg, IN",
"identifier": "70017",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 12317,
"opc": 12408,
"tsq": 0,
"oac": 12408,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-14 21:56:10"
},
{
"id": 11546829,
"location": "Indiana Gas - Seymour, IN",
"identifier": "70018",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 16607,
"opc": 18422,
"tsq": 587,
"oac": 17835,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-14 21:56:10"
},
{
"id": 11546830,
"location": "Equitrans - Waynesburg, PA",
"identifier": "70020",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 4932,
"opc": 5402,
"tsq": 0,
"oac": 5402,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:10",
"piperiv_updated_at": "2025-01-14 21:56:10"
},
...
{
"id": 11547699,
"location": "UNIONTOWN NORTH",
"identifier": "79980",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 677000,
"opc": 677000,
"tsq": 29210,
"oac": 647790,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:12",
"piperiv_updated_at": "2025-01-14 21:56:12"
},
{
"id": 11547700,
"location": "UNIONTOWN NORTH",
"identifier": "79980",
"flow": "R",
"qti": "RPQ",
"zone": "2",
"dc": 552000,
"opc": 552000,
"tsq": 29210,
"oac": 522790,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:12",
"piperiv_updated_at": "2025-01-14 21:56:12"
},
{
"id": 11547701,
"location": "NEXUS INTERCONNECT WITH TETLP,OPEN LATERAL,AT HEAD OF OPEN LATERAL",
"identifier": "79993",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 637559,
"opc": 637559,
"tsq": 0,
"oac": 637559,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:12",
"piperiv_updated_at": "2025-01-14 21:56:12"
},
{
"id": 11547702,
"location": "NEXUS INTERCONNECT WITH TETLP MAINLINE, MONROE CO., OH",
"identifier": "79995",
"flow": "D",
"qti": "DPQ",
"zone": "2",
"dc": 6335806,
"opc": 6335806,
"tsq": 124970,
"oac": 6210836,
"it": "Y",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:12",
"piperiv_updated_at": "2025-01-14 21:56:12"
},
{
"id": 11547703,
"location": "STRATTON RIDGE",
"identifier": "79999",
"flow": "D",
"qti": "DPQ",
"zone": "STX",
"dc": 322000,
"opc": 322000,
"tsq": 310722,
"oac": 11278,
"it": "N",
"all": "Y",
"reason": "",
"piperiv_created_at": "2025-01-14 21:56:12",
"piperiv_updated_at": "2025-01-14 21:56:12"
}
]
}
}