Embed NZX Data on Your Website
Pre-built widgets for stock prices, governance scores, dividends, insider trades, and financials. One script tag. Six widget types. Real-time NZX data on your client portal in under 5 minutes.
Three Steps to Live Widgets
No build tools, no npm packages, no React required. Pure HTML embed that works on any website.
Get Your API Key
Sign up and get your API key from the account page. Pro tier required for widget access.
Create AccountAdd the Script Tag
Drop one script tag before </body>. The embed script is 8KB, loads async, and caches responses for 5 minutes.
<script src="https://nzxplorer.co.nz/widget.js" async></script>Place Your Widgets
Add div elements wherever you want widgets. Set data-type, data-ticker, and data-key attributes.
<div class="nzxplorer-widget" data-type="price-card" data-ticker="AIR" data-key="YOUR_KEY"></div>Six Widget Types
Each widget is self-contained, responsive, and includes NZXplorer attribution and a “not financial advice” disclaimer as required.
Stock Price Card
price-cardLive price, daily change, market cap, 52-week range, and volume. Updates every 5 minutes.
Governance Badge
governance-badgeGRS score (0-100) with rating tier, 6 component breakdown bars, and calculation date.
Dividend History
dividend-historyRecent dividends with ex-dates, DPS, imputation credits, yield, and payout ratio.
Insider Activity
insider-activityDirector share transactions — buys vs sells, director names, dates, and trade values.
Financials Summary
financials-summary5-year income history (revenue, profit, EPS) plus key ratios: P/E, ROE, D/E, yield.
Company Overview
company-overviewCompact company card with price, market cap, YTD return, sector, and GRS governance score.
Copy, Paste, Done
Here is the complete embed code for a stock price card. Replace YOUR_API_KEY with your key from the account page.
<div class="nzxplorer-widget"
data-type="price-card"
data-ticker="AIR"
data-key="YOUR_API_KEY">
</div>
<!-- Add before </body> -->
<script src="https://nzxplorer.co.nz/widget.js" async></script>Change data-type to any of the 6 widget types. Change data-ticker to any NZX ticker symbol (AIR, FPH, SPK, MEL, etc.).
Programmatic API
Build custom integrations with the JSON Widget API directly.
curl -H "X-API-Key: YOUR_KEY" \
"https://nzxplorer.co.nz/api/v1/widgets/price-card?ticker=AIR"
# Response:
{
"widget": "price-card",
"ticker": "AIR",
"name": "Air New Zealand",
"price": 7.42,
"change_pct": 1.23,
"market_cap": 3100000000,
"attribution": { "source": "NZXplorer", "disclaimer": "..." }
}6 widget endpoints
price-card, governance-badge, dividend-history, insider-activity, financials-summary, company-overview
Standard REST API
JSON responses, X-API-Key auth, CORS enabled, 5-minute cache headers
130 NZX companies
All active NZX-listed issuers. Updated daily from NZX filings and market data.
Widget API Pricing
The Widget API is included with Pro and Enterprise plans. No per-widget or per-impression charges.
Pro
- All 6 widget types
- Up to 3 configured domains
- 100 requests per minute
- Light and dark themes
- 5-minute data refresh
- NZXplorer attribution required
Enterprise
- All 6 widget types
- Unlimited domains
- 500 requests per minute
- Light, dark, and custom themes
- 5-minute data refresh
- Custom branding (remove NZXplorer logo)
- Bulk data API access
- Priority support
API Key Authentication
Every widget request is authenticated via X-API-Key header. Keys are rate-limited per tier.
CORS Domain Locking
Pro keys are restricted to configured domains. Enterprise keys support wildcard origins.
CDN Cached, 8KB Script
The widget script loads asynchronously, caches responses client-side for 5 minutes, and never blocks page rendering.
Frequently Asked Questions
What data do the widgets display?
Widgets show live NZX data including stock prices, governance scores, dividend history, insider trades, financial summaries, and company overviews. Data is sourced from NZX filings and refreshed daily. Widget responses are cached for 5 minutes.
How much does the Widget API cost?
The Widget API is included with Pro ($29/month, up to 3 domains, 100 requests/minute) and Enterprise ($199/month, unlimited domains, 500 requests/minute, custom branding removal). Free tier users can test widgets on localhost.
Can I customise the widget appearance?
Widgets support light and dark themes via the data-theme attribute. Enterprise users can remove NZXplorer branding. The widgets use clean, minimal styling that adapts to most website designs. Custom CSS overrides are possible via the .nzw class namespace.
How do I restrict which domains can use my API key?
Pro keys work from up to 3 configured domains. Enterprise keys work from any domain. Domain restrictions are managed from your account settings. CORS headers are automatically set based on your tier.
Is there a rate limit?
Pro tier allows 100 widget requests per minute across all your domains. Enterprise allows 500 per minute. The embed script caches responses client-side for 5 minutes, so a page with 3 widgets visited by 100 users generates far fewer API calls than you might expect.
Do I need to display attribution?
Yes. All widgets include a small "Data: NZXplorer" footer and "Not financial advice" disclaimer. This is required by our terms of service and aligns with FMA fair dealing obligations. Enterprise users can customise (but not remove) the disclaimer text.
Ready to Embed NZX Data?
Get your API key in 60 seconds. Widgets render live NZX data on your website immediately. No build tools required.
Data sourced from publicly available NZX filings. Our datasets may not be complete. Automated analysis can produce errors. If you believe any data on this page is incorrect, please contact us at hello@nzxplorer.co.nz. For informational purposes only. Not investment advice.