Southwest Power Pool Forecasting API is one of 11 APIs that Southwest Power Pool publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Forecasting. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
6 operations
across 4 paths,
and defines 57 schemas.
It is described by OpenAPI 3.2.0, at version 1.1.0.
Requests are made against a single base URL, https://trolie.example.com.
The identity and technical contract details declared by the specification.
named-power-system-resources
array
Collection of power system resource names
forecast-snapshot-header-elide-psr
object
Details about the snapshot provided by the Clearinghouse provider. The power-system-resources property is omitted from this header.
4 properties
3 required
empty
stringnull
Intended to proactively avoid information disclosure
limit-value-set
array
A set of general limit or rating values, each mapped to the various limit bands defined by the Transmission Provider's operating manual. This typically consist…
forecast-limit-item-detailed
object
2 properties
2 required
local
string
Contains a identifier that is unique for an object in the context of an exchange between two grid operators.
forecast-proposal-slim-header
object
Populated by the Ratings Provider in a request to submit forecast ratings. The Clearinghouse implementation should record this information, and the detail limi…
7 properties
5 required
forecast-limits-snapshot
object
A snapshot of the forecast for a monitoring set.
2 properties
2 required
overvoltage-threshold-pu
object
An upper limit to voltage for a transmission facility in per unit with the base voltage assumed to be the nominal voltage.
1 property
1 required
limit
object
Defines the limit. In practice most exchanges will only support one kind of limit for proposals and snapshots. However, the specification supports defining lim…
quality-class-current-source
string
This property is modeled after the Quality Class called "Current Source" in ICCP. It is used to indicate the source of the current value of the proposed rating…
forecast-limits-snapshot-elide-psr
object
A snapshot of the forecast for a monitoring set.
2 properties
2 required
proposals-considered
array
forecast-snapshot-detailed
object
6 properties
4 required
apparent-power
object
2 properties
1 required
array-max-monitored-elements_forecast-proposal
object
2 properties
2 required
overvoltage-threshold
object
An upper limit to voltage for a transmission facility in kilovolts.
1 property
1 required
entity
string
Contains a unique identifier for an entity, such as a grid operator or organization. This identifier is typically used in the context of data exchange between…
undervoltage-threshold
object
A lower limit to voltage for a transmission facility in kilovolts.
1 property
1 required
active-power-with-power-factor
object
3 properties
2 required
temporary-aar-exceptions
array
active-power
object
2 properties
1 required
forecast-limit-item
object
2 properties
2 required
limiting-analysis
string
Indicates how a operating limit was determined. This is used to provide context for the ratings proposals and limits snapshots. When defined in the header, thi…
resource-forecast-inputs
array
period-start
string
RFC 3339 date-time string with no fractional seconds component that designates a start or end to an operating period (such as an hour) that starts at a specifi…
resource-forecast-proposal
object
2 properties
2 required
reactive-power
object
Representation of a limit in megavolt-amperes reactive (MVAR).
1 property
1 required
forecast-provenance
object
Details a proposal that was considered by the Clearinghouse run. If resource-id is not provided, the ratings data is assumed to be for the overall facility.
9 properties
5 required
forecast-proposal-header
object
Populated by the Ratings Provider in a request to submit forecast ratings. The Clearinghouse implementation should record this information, and the detail limi…
5 properties
4 required
undervoltage-threshold-pu
object
An lower limit to voltage for a transmission facility in per unit with the nominal voltage assumed to be the base voltage.
1 property
1 required
problem
object
See [RFC9457](https://www.rfc-editor.org/rfc/rfc9457appendix-A).
5 properties
1 required
forecast-limits-snapshot-slim
object
A slim snapshot of the forecast for a monitoring set.
2 properties
2 required
forecast-limits-snapshot-slim-inputs-used
object
A slim snapshot of the forecast for a monitoring set, including the inputs that were used to determine the continuous limits.
3 properties
2 required
resource-id
string
Contains a unique identifier for a power system resource, such as a transmission facility, segment, interface, etc. This identifier is typically used between r…
unit
string
If the value is dimensionless, this property should not be provided. Since we are not specifying which inputs shall be provided, we cannot specify a definitive…
forecast-snapshot
object
5 properties
4 required
forecast-proposal
object
A Forecasted Period contains proposed limits for a power system object, e.g., a segment, that were forecasted for a particular Period in a Forecast Window. The…
7 properties
4 required
resource-forecast-proposal-slim
array
operator-override-limit-provenance
object
Data structure for a temporary AAR Exception against a resource. Includes a unique ID, start and (optional) end time, and a reason. May or may not include a se…
8 properties
4 required
names
object
2 properties
1 required
forecast-snapshot-slim-header
object
Details about the snapshot provided by the Clearinghouse provider.
6 properties
5 required
forecast-limits-detailed-snapshot-elide-psr
object
A detailed snapshot of the forecast for a monitoring set. These details are meant to support analysis, archival, and troubleshooting.
3 properties
3 required
input
object
3 properties
2 required
forecast-limits-detailed-snapshot
object
A detailed snapshot of the forecast for a monitoring set. These details are meant to support analysis, archival, and troubleshooting.
3 properties
3 required
data-provenance
object
Provides information about where the associated representation came from. No functional aspects of the exchange are contingent upon this data. However, this in…
3 properties
2 required
name-type
string
Type of the name being referenced. Corresponds to the IEC CIM NameType concept.
emergency-durations
array
Defines the durations in minutes used for emergency limits.
current
object
Representation of a thermal limit in amperes.
1 property
1 required
temporary-aar-exception-provenance
object
Data structure for a temporary AAR Exception against a resource. Includes a unique ID, start and (optional) end time, and a reason. May or may not include a se…
8 properties
4 required
forecast-proposal-slim
object
3 properties
2 required
timestamp
string
RFC 3339 date-time string with a maximum of 10 digits in the fractional seconds component, i.e., nanosecond precision.
forecast-snapshot-header
object
Details about the snapshot provided by the Clearinghouse provider.
5 properties
4 required
forecast-proposal-status
object
Status of the rating provider's forecast proposal relative to the current forecast window. Includes any validation errors encountered while processing proposal…
6 properties
6 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Southwest Power Pool publishes across the network.
