PipeRiv

Capacity

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.

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: