Energy · New Zealand

Explore NZ electricity market data

Preview: Review New Zealand wholesale electricity prices, monthly retailer connection counts, and public network and meter details for a known connection point.

Tool ID

nz_electricity_market

Preview: Review New Zealand wholesale electricity prices, monthly retailer connection counts, and public network and meter details for a known connection point.

ServerNew Zealand
Information categoryPublic electricity market data
Credit behavior1 credit
AccessWorkspace permissions

Inputs and outputs

Published input schema

Use the discovered runtime schema for the workspace you are connected to.

Public catalog
nz_electricity_market input schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dataset": {
      "type": "string",
      "enum": [
        "wholesale_prices",
        "connection_counts",
        "icp_lookup"
      ]
    },
    "node": {
      "type": "string",
      "minLength": 3,
      "maxLength": 20
    },
    "since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "until": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "at": {
      "description": "NZ local HH:mm interval label on a five-minute boundary; use with one date. Archived publish times are matched to the nearest interval label.",
      "type": "string",
      "maxLength": 5
    },
    "period": {
      "description": "Required for connection_counts: a month in YYYY-MM format; omit for other datasets.",
      "type": "string",
      "maxLength": 20
    },
    "region_type": {
      "type": "string",
      "enum": [
        "national",
        "island",
        "zone",
        "main_centre",
        "regional_council",
        "network_reporting_region",
        "network_participant",
        "root_nsp"
      ]
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "retailer": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "icp": {
      "type": "string",
      "maxLength": 32
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    },
    "fields": {
      "description": "Optional exact result keys to return. Omit this parameter to return all fields; wildcard `*` is not supported.",
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-zA-Z][a-zA-Z0-9_.-]*$"
      }
    }
  },
  "required": [
    "dataset"
  ],
  "additionalProperties": false
}

Published output shape

Tool results return structured data or a stable error object.

Shared Aroai tool output schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "summary": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        "executionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "creditsCharged": {
          "type": "number",
          "minimum": 0
        },
        "usage": {
          "type": "object",
          "properties": {
            "credits_charged": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "credits_remaining": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "credits_charged"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "summary",
        "data",
        "creditsCharged"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "retryable": {
              "type": "boolean"
            }
          },
          "required": [
            "code",
            "message",
            "retryable"
          ],
          "additionalProperties": false
        },
        "usage": {
          "type": "object",
          "properties": {
            "credits_charged": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "credits_remaining": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "credits_charged"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "error"
      ],
      "additionalProperties": false
    }
  ]
}

Source and usage notes

Understand the result boundary

  • Choose wholesale prices, connection counts or a connection-point lookup.
  • Wholesale price queries cover one date at a time within the latest 31 days.
  • Wholesale prices are interim and are not final settlement prices, retail tariffs, consumption or customer identity. Address search is not supported.
Explore AU/NZ toolkits

Use this capability

Build on your next business question.

Explore related tools or connect your AI client to get started.

Local intelligence. Ready to build.

Put your AI to work.

Create a free workspace and bring local business context into your AI tools.