Gets a selection of operational data of a block as a timeseries.

Gets a selection of operational data of a block as a timeseries.

Returns a JSON representation of the selected operational data and its metadata at 15 minute granularity.

The user selects the relevant categories of operational data through the query parameter categories, which is a comma separated list. E.g. categories=powerCapacityChargeAvailable,powerCapacityDischargeRated The following categories are available for blocks:

powerCapacityChargeRated: The rated charge power capacity of the block in kW, e.g. 8000.0.

powerCapacityChargeAvailable: The available charge power capacity of the block in kW, e.g. 8000.0.

powerCapacityDischargeRated: The rated discharge power capacity of the block in kW, e.g. 8000.0.

powerCapacityDischargeAvailable: The available discharge power capacity of the block in kW, e.g. 8000.0.

boundaryPower: The wholesale power that the asset reaches at the boundary between delivery periods in kW. For example, 4000.0 kW at 12:15 implies that asset will be delivering exactly 4000 kW at exactly 12:15, which is the boundary between the [12:00, 12:15] and [12:15, 12:30] delivery periods. This will in general be different from the scheduled power values for a delivery period which are reflective of the average power delivered over each periods. For more information on relevant ramping constraints, see the layr user guide.

deliveryPeriodSetpoint: The wholesale power the asset ramps to between the two adjacent boundary powers in kW, considering the ramping constraints. For example, 4500.0 kW at 12:00 means the asset ramps to 4500 kW somewhere within the [12:00, 12:15] delivery period. The setpoint is in general different from the schedule value, as the schedule value describes the average power throughout a quarter. Each setpoint is documented against the timestamp of its quarter — i.e., a setpoint with value 4500.0 kW and timestamp 12:15 corresponds to the [12:15, 12:30] delivery period. Note that the setpoint level is not necessarily achieved at that exact point in time, but normally somewhere within the quarter. For more information on relevant ramping constraints, see the layr user guide.

schedule: The active scheduled power output/input of the block in kW, e.g. 5000.0.

acceptedSchedule: The accepted schedule power for the block in kW, e.g. 4800.0.

adjustedSchedule: The adjusted schedule power for the block in kW, e.g. 3800.0.

undeliverableSchedule: The portion of the virtual asset’s scheduled wholesale power in kW that is considered “protected” during an ongoing unavailability. State of energy changes that result from this power will be accounted against the frozen-energy of the asset.

Along with the selected operational data, a metadata object is returned which provides the unit for the selected datapoint.

For detailed information about schedule adjustments including the reason for adjustments, use the block adjustments endpoint.

Note that it is required to provide start and end params to specify the time interval for which to retrieve values. This range is greedy, in that it will match any timeseries point included in its range, including on the boundaries. e.g., setting a start of 2025-06-17T00:00:00Z and an end of 2025-06-17T00:30:00Z would return the points at 00:00:00, 00:15:00, and 00:30:00 which collectively cover a period from 00:00:00 to 00:45:00.

An example response would be:

{
  "data": {
    "powerCapacityChargeAvailable": {
      "metaData": {
        "unit": "kW"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 8000.0
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "value": 8000.0
        }
      ]
    },
    "powerCapacityDischargeRated": {
      "metaData": {
        "unit": "kW"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 8000.0
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "value": 8000.0
        }
      ]
    },
    "schedule": {
      "metaData": {
        "unit": "kW"
      },
      "dataPoints": [
        {
          "timestamp": "2025-07-11T22:00:00Z",
          "value": 5000.0
        },
        {
          "timestamp": "2025-07-11T22:15:00Z",
          "value": 5000.0
        }
      ]
    }
  }
}