---
title: "Sector Heatmap"
method: GET
path: "/sector-heatmap"
tags: ["Market Data"]
---

# Sector Heatmap

`GET /sector-heatmap`

## Request

- Base URL: `https://nzxplorer.co.nz/api/v1`
- URL: `https://nzxplorer.co.nz/api/v1/sector-heatmap`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

NZX market sectors aggregated by market cap with average weekly or monthly performance. Supports drill-down to individual companies within a sector via ?sector= filter.

## Query parameters

- `period` string
- `sector` string

## Response `200`

Sector Heatmap

- Envelope: Standard API response envelope
  - `data` unknown
  - `meta` object
    - `api_version` string
    - `timestamp` string, date-time
    - `format` 'standard' | 'llm' | 'fdc3' | 'toon'
    - `endpoint` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/nzxplorer/apis/nzxplorer-api.md) · [All operations](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/revisions/f3b95341783a?raw)