Datamine

This endpoint returns aggregated volume or open interest statistics by region and product category. Per-contract open interest is available from End-of-Day Data and Intraday Data.


Endpoint

GET https://www.asxenergy.com.au/api/datamine

Parameters

Name Type Mandatory Description
type enum YES Accepted types: au-volume | au-oi | nz-volume
to string NO Optional upper date bound for volume types.
Format: yyyyMMdd
Default: latest trading date of the corresponding market (AU or NZ)
from string NO Optional lower date bound for volume types.
Format: yyyyMMdd
Default: 365 days before to
Maximum range: 1 year between from and to
date string NO Optional date for the open interest type (au-oi).
Format: yyyyMMdd
Default: latest trading date of the Australian market

API Trial tokens are limited to the latest seven days of aggregation. Requests with from, to, or date outside that window return 400.


Errors

Status When Body
400 type is missing or invalid, a date is invalid, or the requested range exceeds the maximum {"error":"..."}
403 Your token is not entitled to the requested market {"error":"forbidden"}
401
429
Authentication failure or rate limit exceeded See Data API overview

CSV Support

The API supports CSV-formatted responses when requested via the Accept header. To receive data in CSV format, set the following header in your request:

Accept: text/csv

Australian volume

Returns aggregated Australian electricity volume statistics for a date range.

Response

Name Type Mandatory Description
from string YES Effective start date in yyyyMMdd format
to string YES Effective end date in yyyyMMdd format
tradingDays number YES Number of trading days in the range
data object YES Metric groups listed below

data metric groups:

Name Type Description
volume object Contract volume totals by region
quarterlyEquivalentVolume object Quarterly-equivalent volume by region
mwh object Megawatt-hour totals by region
faceValue object Face-value totals by region
count object Trade-count totals by region

Each metric group has one entry per region: nsw, vic, qld, and sa.

For each region, the fields below give that metric’s value broken down by product, by trade type, and by aggregate totals.

Name Type Notes
baseMonthFutures string
baseQuarterFutures string
peakQuarterFutures string
caps string
averageOptions string
calOptions string
finOptions string
peakOptions string
block string Block trades
efp string Exchange for physical
totalFutures string baseMonthFutures + baseQuarterFutures + peakQuarterFutures + caps
totalOptions string averageOptions + calOptions + finOptions + peakOptions
total string totalFutures + totalOptions
average string total ÷ tradingDays

Example

Request:

GET https://www.asxenergy.com.au/api/datamine?type=au-volume

JSON response:

{
  "from": "20250706",
  "to": "20260706",
  "tradingDays": 253,
  "data": {
    "volume": {
      "nsw": {
        "baseMonthFutures": "176",
        "baseQuarterFutures": "88863",
        "peakQuarterFutures": "17",
        "caps": "14324",
        "averageOptions": "60591",
        "calOptions": "13150",
        "finOptions": "8905",
        "peakOptions": "0",
        "block": "96612",
        "efp": "5831",
        "totalFutures": "103380",
        "totalOptions": "82646",
        "total": "186026",
        "average": "735.28"
      },
      "vic": {
        // Same structure as nsw
      },
      "qld": {
        // Same structure as nsw
      },
      "sa": {
        // Same structure as nsw
      }
    },
    "quarterlyEquivalentVolume": {
      // Regions: nsw, vic, qld, sa.
    },
    "mwh": {
      // Regions: nsw, vic, qld, sa.
    },
    "faceValue": {
      // Regions: nsw, vic, qld, sa.
    },
    "count": {
      // Regions: nsw, vic, qld, sa.
    }
  }
}

CSV response:

volume
state,baseMonthFutures,baseQuarterFutures,peakQuarterFutures,caps,totalFutures,averageOptions,calOptions,finOptions,peakOptions,totalOptions,total,average,block,efp
nsw,176,88863,17,14324,103380,60591,13150,8905,0,82646,186026,735.28,96612,5831
vic,91,58094,3,16069,74257,32710,5006,6237,0,43953,118210,467.23,55223,4271
qld,74,69767,9,14214,84064,32637,14752,12052,0,59441,143505,567.21,76021,10103
sa,0,3630,4,1417,5051,118,0,0,0,118,5169,20.43,1352,261

quarterlyEquivalentVolume
# Same structure

mwh
# Same structure

faceValue
# Same structure

count
# Same structure

Australian open interest

Returns aggregated Australian electricity open interest statistics for a single date. Values are aggregated by product category, not per contract.

Response

Name Type Mandatory Description
date string YES Effective date in yyyyMMdd format
data object YES Metric groups listed below

data metric groups:

Name Type Description
openInterest object Open interest by region
quarterlyEquivalentOpenInterest object Quarterly-equivalent open interest by region
mwh object Megawatt-hour open interest by region
faceValue object Face-value open interest by region

Each metric group has one entry per region: nsw, vic, qld, and sa.

For each region, the fields below give that metric’s value broken down by product and by aggregate totals.

Name Type Notes
baseMonthFutures string
baseQuarterFutures string
peakQuarterFutures string
caps string
averageOptions string
calOptions string
finOptions string
peakOptions string
totalFutures string baseMonthFutures + baseQuarterFutures + peakQuarterFutures + caps
totalOptions string averageOptions + calOptions + finOptions + peakOptions
total string totalFutures + totalOptions

Example

Request:

GET https://www.asxenergy.com.au/api/datamine?type=au-oi&date=20250717

JSON response:

{
  "date": "20250717",
  "data": {
    "openInterest": {
      "nsw": {
        "baseMonthFutures": "169",
        "baseQuarterFutures": "11166",
        "peakQuarterFutures": "46",
        "caps": "5102",
        "averageOptions": "5149",
        "calOptions": "3023",
        "finOptions": "1276",
        "peakOptions": "0",
        "totalFutures": "16483",
        "totalOptions": "9448",
        "total": "25931"
      },
      "vic": {
        // Same structure as nsw
      },
      "qld": {
        // Same structure as nsw
      },
      "sa": {
        // Same structure as nsw
      }
    },
    "quarterlyEquivalentOpenInterest": {
      // Regions: nsw, vic, qld, sa.
    },
    "mwh": {
      // Regions: nsw, vic, qld, sa.
    },
    "faceValue": {
      // Regions: nsw, vic, qld, sa.
    }
  }
}

CSV response:

openInterest
state,baseMonthFutures,baseQuarterFutures,peakQuarterFutures,caps,totalFutures,averageOptions,calOptions,finOptions,peakOptions,totalOptions,total
nsw,169,11166,46,5102,16483,5149,3023,1276,0,9448,25931
vic,32,10031,4,4841,14908,3635,3794,2055,0,9484,24392
qld,34,16492,5,5395,21926,4445,6366,3745,0,14556,36482
sa,0,722,0,927,1649,51,0,0,0,51,1700

quarterlyEquivalentOpenInterest
# Same structure

mwh
# Same structure

faceValue
# Same structure

New Zealand volume

Returns aggregated New Zealand electricity volume statistics for a date range.

Response

Name Type Mandatory Description
from string YES Effective start date in yyyyMMdd format
to string YES Effective end date in yyyyMMdd format
tradingDays number YES Number of trading days in the range
data object YES Metric groups listed below

data metric groups:

Name Type Description
volume object Contract volume totals by region
quarterlyEquivalentVolume object Quarterly-equivalent volume by region
mwh object Megawatt-hour totals by region
faceValue object Face-value totals by region
count object Trade-count totals by region

Each metric group has one entry per region: otahuhu and benmore.

For each region, the fields below give that metric’s value broken down by product, by trade type , and by aggregate totals.

Name Type Notes
baseMonthFutures string
baseQuarterFutures string
peakQuarterFutures string
calFutures string
averageOptions string
calOptions string
block string Block trades
efp string Exchange for physical
totalFutures string baseMonthFutures + baseQuarterFutures + peakQuarterFutures + calFutures
totalOptions string averageOptions + calOptions
total string totalFutures + totalOptions
average string total ÷ tradingDays

Example

Request:

GET https://www.asxenergy.com.au/api/datamine?type=nz-volume&from=20220706&to=20221230

JSON response:

{
  "from": "20220706",
  "to": "20221230",
  "tradingDays": 125,
  "data": {
    "volume": {
      "otahuhu": {
        "baseMonthFutures": "58421",
        "baseQuarterFutures": "101634",
        "peakQuarterFutures": "0",
        "calFutures": "12",
        "averageOptions": "4400",
        "calOptions": "0",
        "block": "8135",
        "efp": "4617",
        "totalFutures": "160067",
        "totalOptions": "4400",
        "total": "164467",
        "average": "1315.74"
      },
      "benmore": {
        // Same structure as otahuhu
      }
    },
    "quarterlyEquivalentVolume": {
      // Regions: otahuhu, benmore.
    },
    "mwh": {
      // Regions: otahuhu, benmore.
    },
    "faceValue": {
      // Regions: otahuhu, benmore.
    },
    "count": {
      // Regions: otahuhu, benmore.
    }
  }
}

CSV response:

volume
state,baseMonthFutures,baseQuarterFutures,peakQuarterFutures,calFutures,totalFutures,averageOptions,calOptions,totalOptions,total,average,block,efp
otahuhu,58421,101634,0,12,160067,4400,0,4400,164467,1315.74,8135,4617
benmore,53629,101061,0,0,154690,900,0,900,155590,1244.72,3603,1953

quarterlyEquivalentVolume
# Same structure

mwh
# Same structure

faceValue
# Same structure

count
# Same structure