Project operational timeseries

curl --request POST \
  --url 'https://api.renewmap.com.au/api/v1/projects/timeseries/points' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
  "series": ["generation_mwh", "generation_revenue:avg"],
  "from": 1735689600000,
  "to": 1738368000000,
  "interval": "d",
  "duids": ["COOPGWF1"]
}'

{
  "from": 1735689600000,
  "to": 1738368000000,
  "interval": "d",
  "data": [
    {
      "entity_id": "e7347ca7-85b3-4da7-90fa-d3da74fc73a8",
      "series": "generation_mwh",
      "rollup": "sum",
      "key": "COOPGWF1",
      "value": 2412.6,
      "timestamp": "2025-01-01T00:00:00.000Z"
    },
    {
      "entity_id": "e7347ca7-85b3-4da7-90fa-d3da74fc73a8",
      "series": "generation_revenue",
      "rollup": "avg",
      "key": "COOPGWF1",
      "value": 1043.11,
      "timestamp": "2025-01-01T00:00:00.000Z"
    }
  ]
}

Returns the half-hourly generation, curtailment and revenue timeseries that power the charts in a project’s Operational tab, bucketed to the interval you ask for. For transmission lines, see Transmission operational timeseries.

Points are ordered by entity, series and time.

Access

This endpoint requires the Operational Insights add-on on your organisation’s licence, in addition to an API key. Requests without a key return 401, and requests from an organisation without the add-on return 403. Contact [email protected] to enable it.

Authentication is the same as the rest of the API. See Getting started.

Identifying projects

Supply either entity_ids or duids. If neither is present the request fails with 400. Any field outside the table above is rejected, so line_* series and transmission-only fields are not accepted here.

entity_ids are the id values returned by Get a list of projects. Project ids resolve through the DUIDs registered against the project, so a project with no DUID has no operational data.

Series

Project series are keyed by DUID; a project with more than one DUID returns a point per DUID.

Requesting a name outside this list returns 400 with the list of accepted series in the message.

Curtailment and revenue are split rather than totalled. Add both curtailment_*_mwh series for total curtailment, and generation_revenue plus load_revenue for net revenue.

Rollups

Each series entry is a name, optionally followed by a colon and a rollup: "generation_mwh" or "generation_mwh:avg". The rollup sets how the half-hourly readings in a bucket become one value.

• A bare name uses that series’ default, shown per series above
• An unsupported rollup returns 400 naming the ones that series accepts
• A series can repeat with different rollups. ["generation_mwh:avg", "generation_mwh:sum"] returns two points per bucket, separated by the rollup field
• Rollups combine within a bucket, never across projects, so a sum over five projects returns five sums
• At interval: "hh" both rollups return the same value, since the bucket holds one reading
• non-default rollups may have unintuitive definitions. e.g. generation_mwh:avg will return the average mwh per half hour, and would need to be multiplied by 2 to get average mw

Response

Projects and periods with no data are absent from data rather than returned as null, so an empty data array is a normal response for a project that reports no telemetry.

Adding time_of_day_intervals returns a point per bucket per requested half-hour slot, each carrying both a timestamp and a half_hour. Slots with no reading for a bucket are omitted, so a bucket can carry fewer points than the number of slots you requested.

How values are aggregated

A daily generation_revenue under sum is the day’s total; under avg it is the average per half hour. MWh and dollars are normally read as totals, which is why every series defaults to sum. See Revenue & Missed Revenue.

Averages are recombined from stored sums and counts rather than averaged again, so a bucket with missing readings is not weighted incorrectly. A sum totals only the readings that exist. Check interval on the response before reading a sum, since a coarsened bucket covers a longer period than requested.

Timestamps

All timestamps and half-hour slots are in market time: Australian Eastern Standard Time (UTC+10), with no daylight saving adjustment all year. Slot 1 is 00:00 to 00:30 and slot 48 is 23:30 to 00:00. See Data sources & coverage.

Limits

• Maximum 500 entity_ids or duids per request
• A response is capped at roughly 5,000 buckets. When the range and interval you asked for would exceed that, the endpoint steps the interval up (hh to d, then w, m, y) until the request fits, and returns the interval it actually used in the interval field. A year of hh data comes back as d. Read interval from the response rather than assuming your request was honoured, and page through shorter ranges to keep half-hourly resolution over a long period
• Requests are rate limited per organisation. Exceeding the limit returns 429. See Getting started

Errors

Error responses carry a JSON body with a message field. Validation failures are joined into a single message, so one response can describe several problems.