v1

latestOpenAPI 3.1.02026-07-131034192.8 KB

GET Index

Get the current CO2 MOER index

Returns the current index value for the specified region for the co2_moer signal type. This 0-100 value is the statistical percentile of the current MOER relative to the upcoming 24 hours of forecast MOER values for the specified location (100=dirtiest, 0=cleanest). Values are updated 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. No historical query is available for this endpoint.

Data from this endpoint is available for free to all users in all covered regions.

get/v3/signal-index

Query parameters

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

signal_type'co2_moer' required

Only co2_moer indices are currently available.

Example:co2_moer

Only co2_moer indices are currently available.

Response

Successful Response

Example response

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