Sign in

v1

latestOpenAPI 3.1.02026-07-131034192.8 KB
GET Historical

Get a range of historical signal data

Returns signal data (e.g. CO₂ MOER in lbs/MWh) for the specified region, signal_type, and time period. Values are published in near real-time, periodically (e.g. at 5-minute frequency), and each value is valid starting from its point_time for the duration described in data_point_period_seconds. The publishing delay (the difference between the point_time for the value and the time that value is available in the API) varies by grid region. In some regions the data will be available within one minute after a certain point_time, in other regions there may be a delay of up to a few hours. Each query is limited to 32 days of data. Individual data point values may be updated at any time after publishing (e.g. if better source data is obtained).

get/v3/historical

Query parameters

startstring date-time required

(inclusive) ISO8601-compliant timezone-aware date string indicating earliest desired data, used to select the first point_time included in the response

Example:2023-03-31T13:42:00Z

(inclusive) ISO8601-compliant timezone-aware date string indicating earliest desired data, used to select the first point_time included in the response

endstring date-time required

(inclusive) ISO8601-compliant timezone-aware date string indicating latest desired data, used to select the last point_time included in the response

Example:2023-03-31T13:42:00Z

(inclusive) ISO8601-compliant timezone-aware date string indicating latest desired data, used to select the last point_time included in the response

regionstring required

Region abbreviation associated with location, from result of query to /v3/region-from-loc

Example:CAISO_NORTH

Region abbreviation associated with location, from result of query to /v3/region-from-loc

'co2_moer' | 'health_damage' required
OR
'co2_aoer' required

Use to select any available signal_type which is authorized for your account

modelstring date nullable

Use to return different models from defaults.

Example:2022-10-01

Use to return different models from defaults.

include_imputed_markerboolean

Use to return whether or not the value associated with a point_time is generated with imputed data.

Example:true

Use to return whether or not the value associated with a point_time is generated with imputed data.

updated_sincestring date-time nullable

Filter results for data newer than the provided datetime.

Example:2022-01-01T00:00:00Z

Filter results for data newer than the provided datetime.

Response

Successful Response

Example response

{
  "data": [
    {
      "imputed_data_used": true,
      "last_updated": "2023-10-01T00:00:00Z",
      "point_time": "2022-07-15T00:00:00Z",
      "value": 870
    },
    {
      "imputed_data_used": true,
      "last_updated": "2023-10-01T00:05:00Z",
      "point_time": "2022-07-15T00:05:00Z",
      "value": 860
    }
  ],
  "meta": {
    "data_point_period_seconds": 300,
    "model": {
      "date": "2023-03-01",
      "type": "binned_regression"
    },
    "region": "CAISO_NORTH",
    "signal_type": "co2_moer",
    "units": "lbs_co2_per_mwh",
    "warnings": [
      {
        "message": "This is just an example",
        "type": "EXAMPLE_WARNING"
      }
    ]
  }
}