NZXplorer API

v1

Free API access to New Zealand capital market data. Companies, directors, governance scores, stock prices, and 64,000+ market announcements.

Quick Start

1

Get an API key

Email api@nzxplorer.co.nz with your use case

2

Add your API key

Include as X-API-Key header

3

Start building

All endpoints return JSON

curl -H "X-API-Key: YOUR_KEY" \
  "https://nzxplorer.co.nz/api/v1/companies?sector=Technology"

Authentication

All API requests require authentication via an API key. Pass your key in one of two ways:

Header (recommended)

X-API-Key: YOUR_KEY

Query parameter

?api_key=YOUR_KEY

Keep your API key secret. Never expose it in client-side code or public repositories.

Rate Limits

TierRate LimitPriceUse Case
Free10 req/min$0Personal projects, research, prototyping
Pro100 req/minContact usApps, dashboards, data pipelines
Enterprise500 req/minContact usHigh-volume, commercial use
Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-API-Tier

LLM-Optimized Format

Add ?format=llm to any endpoint for token-optimized output. This strips null values, empty arrays, and metadata — ideal for feeding into LLMs and AI agents.

Standard format

{
  "data": {
    "ticker": "AIR",
    "name": "Air New Zealand",
    "description": null,
    "website_url": null,
    "directors": []
  },
  "meta": {
    "api_version": "v1",
    "timestamp": "2026-03..."
  }
}

LLM format (?format=llm)

{
  "ticker": "AIR",
  "name": "Air New Zealand"
}

~70% fewer tokens. Same data, no nulls or empty fields.

TOON Token-Optimized Output

Add ?format=toon to any endpoint for maximum token compression. TOON (Token-Optimized Object Notation) encodes arrays of objects as pipe-delimited tabular data — 30-60% fewer tokens than JSON with lossless roundtrip fidelity.

Standard JSON

[
  {"ticker":"AIR","name":"Air NZ","sector":"Industrials"},
  {"ticker":"FPH","name":"Fisher & Paykel","sector":"Healthcare"},
  {"ticker":"MEL","name":"Meridian","sector":"Utilities"}
]

TOON format (?format=toon)

ticker|name|sector
AIR|Air NZ|Industrials
FPH|Fisher & Paykel|Healthcare
MEL|Meridian|Utilities

~50% fewer tokens. Lossless — decode(encode(data)) == data. Nested objects use dot-notation key folding.

Best for: AI agent pipelines, MCP tool results, and Copilot tool calls. The NZXplorer Copilot auto-encodes large array results (>8KB) in TOON format internally, reducing token costs by 30-60%. Response header: X-Format: toon. Content-Type: text/plain.

FDC3 Interoperability

Add ?format=fdc3 to supported endpoints for FINOS FDC3 v2.0 standard context types. Enables interoperability with Bloomberg, Refinitiv, IRESS, and other FDC3-compliant desktop applications. All 131 issuers have ISINs, and LEIs are available for 65/131 issuers (50% coverage) via the GLEIF register.

Standard format

{
  "data": {
    "ticker": "AIR",
    "name": "Air New Zealand",
    "isin": "NZAIRE0001S2",
    "sector": "Industrials"
  }
}

FDC3 format (?format=fdc3)

{
  "type": "fdc3.instrument",
  "name": "Air New Zealand",
  "id": {
    "ticker": "AIR",
    "ISIN": "NZAIRE0001S2",
    "LEI": "XN8VX00V0UCRJ3ZGN385"
  },
  "market": {
    "MIC": "XNZE",
    "name": "New Zealand Exchange",
    "COUNTRY_ISOALPHA2": "NZ"
  }
}

Supported endpoints:

/companies/companies/:ticker/directors/directors/:slug/insider-trades/shareholders/:ticker/prices/:ticker/metrics/:ticker/dividends/:ticker/earnings/:ticker

FDC3 context type mapping:

EndpointFDC3 Type
/companiesfdc3.instrumentList
/companies/:tickerfdc3.instrument
/directorsfdc3.contactList
/directors/:slugfdc3.contact
/insider-tradesfdc3.tradeList
/shareholders/:tickerfdc3.portfolio
/prices/:tickerfdc3.chart
/metrics/:tickerfdc3.valuation
/dividends/:tickerfdc3.instrument + dividends
/earnings/:tickerfdc3.instrument + earnings

Desktop Agent Intents

When running inside an FDC3-compliant desktop agent (IRESS MyIress, OpenFin, Glue42), NZXplorer registers intent listeners and broadcasts instrument context automatically. No configuration needed — the integration is a no-op in standard browser environments.

IntentContextAction
ViewChartfdc3.instrumentNavigate to company chart view
ViewInstrumentfdc3.instrumentNavigate to company overview page
ViewProfilefdc3.contact / fdc3.instrumentNavigate to person or company profile
ViewResearchfdc3.instrumentOpen proxy advisory report
ViewQuotefdc3.instrumentReturn latest price as fdc3.valuation

NZXplorer also broadcasts fdc3.instrument context when users navigate between company pages, enabling other connected apps to update in sync.

App Directory Manifest

NZXplorer publishes an FDC3 App Directory v2 manifest for registration with desktop agent platforms.

Listens For

ViewChartViewInstrumentViewProfileViewResearchViewQuote

Broadcasts

fdc3.instrumentfdc3.instrumentListfdc3.portfolio

Context Listener

fdc3.instrumentfdc3.contactfdc3.organization

NZXplorer Copilot

An AI research assistant that uses all NZXplorer API endpoints to answer natural language questions about NZX-listed companies. Powered by Claude with tool-calling against 36 internal data tools. Features hybrid semantic search with reranking, structured copilot cards for rich visual output, and TOON token optimization for 30-60% cost reduction.

Web Interface

Try the Copilot in your browser — available on every page via the floating button, or as a full-page experience.

Open NZXplorer Copilot →

CLI Agent

A terminal-based research agent with 53 NZX tools, DCF valuation skills, and live RBNZ OCR data. Built on LangChain.

npx nzxplorer-agent
View on GitHub →

API Endpoint

Use the POST /api/v1/ask endpoint to integrate the Copilot into your own applications. Supports SSE streaming, multi-turn conversations, and 4 analyst personas (general, macro, governance, risk). Pass "persona": "governance" in the request body to frame analysis through a specific lens.

# Default (general) persona
curl -X POST -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question": "What is the governance score for Air NZ?"}' \
  "https://nzxplorer.co.nz/api/v1/ask"

# With analyst persona (macro, governance, or risk)
curl -X POST -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question": "How does the OCR cycle affect utilities?", "persona": "macro"}' \
  "https://nzxplorer.co.nz/api/v1/ask"

Structured Copilot Cards

When analysis fits a known schema, the Copilot returns structured JSON that the UI renders as visual cards. 5 card types are supported:

company_analysis

Bull/bear case, key metrics, governance flags

sector_comparison

Side-by-side multi-company metrics

risk_assessment

Risk level, factors, mitigation, confidence

dividend_outlook

Yield, safety, cut probability, payout ratio

director_profile

Boards, overboarding risk, voting support

Hybrid Search + Reranking

The Copilot's search_semantic tool combines BM25 keyword search with pgvector semantic similarity via Reciprocal Rank Fusion (RRF, k=60), optionally reranked by Cohere rerank-v3.5. This finds both exact keyword matches and conceptual matches across 64,000+ NZX announcements. The same hybrid search powers the /api/v1/semantic-search?mode=hybrid&rerank=true endpoint.

MCP Server

Connect NZXplorer data directly to Claude Desktop, Cursor, or any MCP-compatible client. 42 tools wrapping the full API — including proxy advisory, anomaly detection, market signals, stock screening, accounting quality, IR quality, peer mentions, board briefings, skills matrices, and research briefings.

npx nzxplorer-mcp

Add to your Claude Desktop config or Cursor MCP settings. See GitHub repo for setup instructions.

Multi-MCP Copilot Integration

The NZXplorer Copilot uses a Multi-MCP architecture — it can connect to external MCP servers alongside its native 91 tools. This allows the AI to cross-reference NZXplorer data with live external sources in a single conversation.

NZ Companies Office

Live NZBN lookups, official director lists, registration status — cross-referenced with NZXplorer's extracted data.

Web Search

Real-time news, FMA notices, and breaking company events not yet in the NZXplorer database.

Web Fetch

Read any URL — annual reports, regulatory notices, competitor filings — and combine with NZXplorer analysis.

Check connection status: GET /api/v1/mcp/status

Endpoints

Data Coverage

DatasetRecordsUpdated
NZX-listed companies131Real-time
Company directors2,277Weekly
Governance scores (GRS v2)131Monthly
Stock prices (daily OHLCV)162,000+Daily
Market announcements64,442Daily
Director share transactions9,453Weekly
Executive compensation1,051Annually
Earnings results1,079Annually
Dividends1,184Weekly
AGM resolutions1,941Annually
Capital raises11,088Annually

Error Codes

CodeMeaning
200Success
400Bad request — check parameters
401Unauthorized — invalid or missing API key
404Not found — resource does not exist
429Rate limited — wait and retry
500Server error — contact support

NZXplorer API v1 — New Zealand Capital Market Intelligence

Questions? Email api@nzxplorer.co.nz