-
Notifications
You must be signed in to change notification settings - Fork 0
API Reference
Users should note that using non supported requests will return a null result.
/api/demand/(region)/(timeperiod)/(year)
This method calls data from the Price and Demand data, returning data in JSON format depending on following parameters. If no further parameters are provided, yearly averages by state from 2009 will be returned in megawatts.
/api/consumption/(region)/(timeperiod)/(year)
Consumption data generated from demand data. 30 minute demand data in megawatts is assumed to be average demand for the duration of the 30 minutes. These values are converted to megawatt hours and accumulated according to time period parameter. If no further parameters are provided, annual consumption from 2009 will be returned in megawatt hours.
/api/supply/(all)
Supply data is returned from generator supply data. If no further parameters are provided, this function will return yearly averages of total generation by state from 2009 in megawatts.
/api/supply/renewable/(region)/(timeperiod)/(year)
Returns generator supply data filtered for only renewable generators.
/api/supply/fossil/(region)/(timeperiod)/(year)
Returns generator supply data filtered for only fossil fuelled generators.
/api/production/(all)/(region)/(timeperiod)/(year)
Returns production data generated from supply data. 30 minute supply data in megawatts is assumed to be average demand for the duration of the 30 minute period. These data-points are converted to megawatt hours and accumulated according to time period parameter. If no further parameters are provided, annual consumption from 2009 will be returned in megawatt hours.
/api/production/renewable/(region)/(timeperiod)/(year)
Returns production data filtered for only renewable generators.
/api/production/fossil/(region)/(timeperiod)/(year)
Returns production data filtered for only fossil fuelled generators.
/api/rrp/(region)/(timeperiod)/(year)
Returns regional reference price from Price and Demand data. 30 minute price data in dollars are assumed to be the price per megawatt hour for the duration of that 30 minute. If no other parameters are provided, annual priced data per state from 2009 will be returned.
/api/(data)/nsw/(timeperiod)/(year)
Filters data to only return data for New South Wales.
/api/(data)/qld/(timeperiod)/(year)
Filters data only return data for Queensland.
/api/(data)/sa/(timeperiod)/(year)
Filters data to only return data for South Australia.
/api/(data)/tas/(timeperiod)/(year)
Filters data to only return data for Tasmania.
/api/(data)/vic/(timeperiod)/(year)
Filters data to only return data for Victoria.
/api/(data)/nem/(timeperiod)/(year)
Collects data from all states and returns data for the whole NEM.
/api/(data)/(region)/yearly
Returns yearly average of requested data.
/api/(data)/(region)/monthly
Returns monthly average for requested data.
/api/(data)/(region)/weekly
Returns weekly average for requested data.
/api/(data)/(region)/daily
Returns daily average for requested data.
/api/(data)/(region)/hourly
Returns hourly average for requested data.
/api/(data)/(region)/raw
Returns raw half hour data for requested data.
/api/(data)/(region)/(timeperiod)/2009/
/api/(data)/(region)/(timeperiod)/2010/
/api/(data)/(region)/(timeperiod)/2011/
Filters data by year for requested data. Earliest data is from January 2009.