Priority Power API

Documentation of APIs managed by Priority Power.
Postman collection available upon request.
Accessible at https://docs.ppm-bi.com
Contact Info: BITeam@prioritypower.com
Version: 1
© 2023 Priority Power, All Rights Reserved

Access

Production https://api.ppm-bi.com
Sandbox https://api.ppm-bi.com/test

Methods

Table of Contents

API

API

get /4_cp
(ercot4cpGet)
Returns 15 minute windows for the current day with Y/N curtailment variable.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

date
— format: yyyy-mm-dd

Return type

/ercot/4_cp

Example data

Content-Type: application/json
            
[
    {
        "start_time": "2023-08-07 14:15:00",
        "end_time": "2023-08-07 14:30:00",
        "4_cp_curtail_flag": "N"
    },
    {
        "start_time": "2023-08-07 14:30:00",
        "end_time": "2023-08-07 14:45:00",
        "4_cp_curtail_flag": "Y"
    }
]

Produces

This API call prduces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /ercot/ancillary
(ercotAncillaryGet)
Returns ERCOT AS (Ancillary Service) MCPC (Market Clearing Price for Capacity) and volumes by hour for day-ahead.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

from_date
— format: yyyy-mm-dd
to_date
— format: yyyy-mm-dd

Return type

ancillary

Example data

Content-Type: application/json
            
[
    {
        "effective_from": "2023-05-12 00:00:00",
        "effective_to": "2023-05-12 01:00:00",
        "ercot_dam_nspin": 1.2,
        "ercot_dam_regdn": 5.01,
        "ercot_dam_regup": 3.23,
        "ercot_dam_rrs": 1.2,
        "ercot_nspin_quantity": 4536.0,
        "ercot_regdn_quantity": 483.0,
        "ercot_regup_quantity": 220.0,
        "ercot_rrs_quantity": 3041.0
    },
    {
        "effective_from": "2023-05-12 01:00:00",
        "effective_to": "2023-05-12 02:00:00",
        "ercot_dam_nspin": 1.11,
        "ercot_dam_regdn": 4.96,
        "ercot_dam_regup": 2.0,
        "ercot_dam_rrs": 1.15,
        "ercot_nspin_quantity": 4536.0,
        "ercot_regdn_quantity": 366.0,
        "ercot_regup_quantity": 233.0,
        "ercot_rrs_quantity": 3041.0
    }
]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /ercot/lmp_prices
(ercotLmpGet)
Provides access to current operating day RTSPP (Real-Time Settlement Point Prices).
*The latest price may be up to 80 seconds delayed.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

pricing_point
— lz_north, lz_south, lz_west, lz_houston, hb_north, hb_south, hb_west, hb_houston

Return type

rtspp

Example data

Content-Type: application/json
            
{
    "date" : "2023-05-18",
    "pricing_point" : "lz_north",
    "time" : ["00:00:00", "00:05:00"],
    "spp" : [0.8008281904610115, 0.8008281904610115]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

403

503


get /ercot/load
(ercotLoadGet)
Provides access to current ERCOT Total Load (Demand) and includes the MTD (month to date) max.
*The MTD max excludes current operating day.

Request headers

x-api-key
API Key provided by Priority Power

Return type

ercot_total_load

Example data

Content-Type: application/json
            
{
    "record_time": "2023-05-05 18:06:36",
    "ercot_total_load": 67757.79,
    "mtd_max": 56721.80078125,
    "unit": "MW"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /ercot/lmp/prices_with_off_cycle
(ercotLmpWithOffCycleGet)
Provides access to current operating day Security Constrained Economic Dispatch (SCED) prices.
*The latest price may be up to 80 seconds delayed.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

pricing_point
— lz_north, lz_south, lz_west, lz_houston, hb_north, hb_south, hb_west, hb_houston

Return type

rtspp

Example data

Content-Type: application/json
            
{
            "date": "2023-11-08",
            "pricing_point": "lz_west",
            "time": ["00:00:00", "00:05:00",],
            "spp": [-0.94, 1.1,]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /ercot/lmp/prices_with_ancillary
(ercotLmpWithAncillaryGet)
Provides access to current operating day 5-minute real-time prices with Ancillary cost.
*The latest price may be up to 80 seconds delayed.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

pricing_point
— lz_north, lz_south, lz_west, lz_houston, hb_north, hb_south, hb_west, hb_houston

Return type

rtspp_ancillary

Example data

Content-Type: application/json
            
[
    {
        "price_date": "2023-09-28T00:00:00",
        "rtspp": 24.79,
        "total_demand": 52181.46,
        "total_ancillary": 6596.76,
        "ancillary_cost": 0.13
    },
    {
        "price_date": "2023-09-28T00:05:00",
        "rtspp": 25.21,
        "total_demand": 51821.62,
        "total_ancillary": 6596.76,
        "ancillary_cost": 0.13
    }
]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

403

503


get /ercot/load
(ercotLoadGet)
Provides access to current ERCOT Total Load (Demand) and includes the MTD (month to date) max.
*The MTD max excludes current operating day.

Request headers

x-api-key
API Key provided by Priority Power

Return type

ercot_total_load

Example data

Content-Type: application/json
            
{
    "record_time": "2023-05-05 18:06:36",
    "ercot_total_load": 67757.79,
    "mtd_max": 56721.80078125,
    "unit": "MW"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /ercot/spp
(ercotSppGet)
Provides access to current operating day 15-minute SPP (Settlement Point Prices).
*The latest price may be up to 5 minutes delayed.

Request headers

x-api-key
API Key provided by Priority Power

Query parameters

pricing_point
— lz_north, lz_south, lz_west, lz_houston, hb_north, hb_south, hb_west, hb_houston

Return type

rtspp

Example data

Content-Type: application/json
            
{
    "date" : "2023-05-04",
    "pricing_point" : "lz_north",
    "time" : [ "00:00:00", "00:15:00" ],
    "spp" : [ 0.8008281904610115, 0.8008281904610115 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /scada
(scadaGet)
Provides access to PPM SCADA system. Data in the PPM SCADA system is updated every 2-3 seconds.

Request headers

x-api-key
API Key provided by Priority Power

Return type

Object

Example data

Content-Type: application/json
            
[
    {
        "asset": "ASSET_NAME_PLACEHOLD",
        "load": 67515,
        "unit": "MW"
    },
    {
        "asset": "ASSET_NAME_PLACEHOLD",
        "load": 97.89,
        "unit": "MW"
    }
]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /monthly/forward_curves
(monthlyforwardcurvesGet)
Provides access to Monthly Forward Curves.

Request headers

x-api-key
API Key provided by Priority Power

Return type

Object

Example data

Content-Type: application/json
            
[
    {
    
    "Region": "ERCOT",
    "Hub/Load Zone": "ASSET_NAME_PLACEHOLD",
    "Block": "7x16",
    "DA (Fin) or RT (Phys)": "Day_Ahead",
    "Trade Date": "2024-01-16",
    "Forward Date": "2024-02-01",
    "Monthly Price": 81.42
    },
    {
    
    "Region": "ERCOT",
    "Hub/Load Zone": "ASSET_NAME_PLACEHOLD",
    "Block": "7x16",
    "DA (Fin) or RT (Phys)": "Day_Ahead",
    "Trade Date": "2024-01-16",
    "Forward Date": "2024-02-01",
    "Monthly Price": 81.97
    }
]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


get /hourly/forward_curves
(hourlyforwardcurvesGet)
Provides access to Hourly Forward Curves.

Request headers

x-api-key
API Key provided by Priority Power

Return type

Object

Example data

Content-Type: application/json
            
[
    {
        "Region": "ERCOT",
        "Hub/Load Zone": "ASSET_NAME_PLACEHOLD",
        "Block": "2x16",
        "Trade Date": "2024-01-16",
        "Forward Date": "2025-01-01",
        "Hour Ending": 7,
        "RT (Phys) Hourly Price": 51.28
    },
    {
        "Region": "ERCOT",
        "Hub/Load Zone": "ASSET_NAME_PLACEHOLD",
        "Block": "2x16",
        "Trade Date": "2024-01-16",
        "Forward Date": "2026-01-01",
        "Hour Ending": 7,
        "RT (Phys) Hourly Price": 51.09
    }
]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

403


Models

Table of Contents

  1. 4_cp
  2. ancillary
  3. ercot_total_load
  4. rtspp
  5. rtspp_ancillary
  6. scada

4_cp

start_time
Datetime
end_time
Datetime
4_cp_curtail_flag
String

ancillary

effective_from
Datetime
effective_to
Datetime
ercot_dam_nspin
Decimal
ercot_dam_regdn
Decimal
ercot_dam_regup
Decimal
ercot_dam_rrs
Decimal
ercot_nspin_quantity
Decimal
ercot_regdn_quantity
Decimal
ercot_regup_quantity
Decimal
ercot_rrs_quantity
Decimal

ercot_total_load

record_time
Datetime
ercot_total_load
Decimal
mtd_max
Decimal
unit
String

rtspp

date
Date
pricing_point
String
time
array[String]
spp
array[Decimal]

rtspp_ancillary

price_date
Date
rtspp
Decimal
total_demand
Decimal
total_ancillary
Decimal
ancillary_cost
Decimal

scada

asset
String
load
Decimal
unit
String