Market Data

Sector Heatmap

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.

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

Query parameters

periodstring

Performance period: 1w (default) or 1m

sectorstring

Drill down to a specific sector for per-company data

Response

Sector Heatmap

dataunknown

Example response

{
  "meta": {
    "api_version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.