Excel Add-in

NZX Data in Microsoft Excel

7 custom functions for stock prices, governance scores, dividends, insider trading, and financials. All 130 NZX-listed companies. Office.js powered, works on desktop and web.

Set Up in 3 Minutes

Download the manifest, sideload it in Excel, and start using NZX functions.

1

Download the Manifest

Click the "Download Manifest" button below to save the manifest.xml file to your computer.

2

Sideload in Excel

Open Excel. Go to Insert > My Add-ins > Upload My Add-in. Browse to the manifest.xml file and upload it.

3

Set Your API Key

Click the NZXplorer button in the ribbon to open the task pane. Enter your API key from nzxplorer.co.nz/account.

4

Use the Functions

Type =NZXPLORER.NZX_PRICE("FPH") in any cell. Functions are namespaced under NZXPLORER. Results are cached for 6 hours.

7 Custom Functions

All functions are namespaced under NZXPLORER. Results are cached for 6 hours to minimise API calls.

NZX_PRICE

Latest closing stock price in NZD.

=NZXPLORER.NZX_PRICE("FPH")35.20

NZX_GRS

Governance Risk Score (0-100). Higher = better governance.

=NZXPLORER.NZX_GRS("FPH")82

NZX_DSS

Dividend Safety Score (0-100). Payout ratio, FCF coverage, consistency.

=NZXPLORER.NZX_DSS("MEL")85

NZX_ICS

Insider Conviction Score (0-100). Buy/sell ratio, director alignment.

=NZXPLORER.NZX_ICS("CEN")68

NZX_DIVIDEND

Latest dividend per share in NZ cents.

=NZXPLORER.NZX_DIVIDEND("SPK")12.5

NZX_FINANCIALS

Financial data by company, year, and field. Values in NZD thousands.

=NZXPLORER.NZX_FINANCIALS("FPH", 2024, "revenue")1856000

NZX_EXPLORER

Universal function. Fetches any metric: pe_ratio, roe, dividend_yield, debt_to_equity, market_cap, sector, and 40+ more.

=NZXPLORER.NZX_EXPLORER("AIR", "pe_ratio")18.5

Example: Stock Comparison Table

Build a live stock comparison table by combining multiple functions. Each cell fetches data independently and caches for 6 hours.

TickerPriceGRSP/E RatioYieldDSS
FPH=NZXPLORER.NZX_PRICE("FPH")=NZXPLORER.NZX_GRS("FPH")=NZXPLORER.NZX_EXPLORER("FPH","pe_ratio")=NZXPLORER.NZX_EXPLORER("FPH","dividend_yield")=NZXPLORER.NZX_DSS("FPH")
AIR=NZXPLORER.NZX_PRICE("AIR")=NZXPLORER.NZX_GRS("AIR")=NZXPLORER.NZX_EXPLORER("AIR","pe_ratio")=NZXPLORER.NZX_EXPLORER("AIR","dividend_yield")=NZXPLORER.NZX_DSS("AIR")
MEL=NZXPLORER.NZX_PRICE("MEL")=NZXPLORER.NZX_GRS("MEL")=NZXPLORER.NZX_EXPLORER("MEL","pe_ratio")=NZXPLORER.NZX_EXPLORER("MEL","dividend_yield")=NZXPLORER.NZX_DSS("MEL")
SPK=NZXPLORER.NZX_PRICE("SPK")=NZXPLORER.NZX_GRS("SPK")=NZXPLORER.NZX_EXPLORER("SPK","pe_ratio")=NZXPLORER.NZX_EXPLORER("SPK","dividend_yield")=NZXPLORER.NZX_DSS("SPK")
CEN=NZXPLORER.NZX_PRICE("CEN")=NZXPLORER.NZX_GRS("CEN")=NZXPLORER.NZX_EXPLORER("CEN","pe_ratio")=NZXPLORER.NZX_EXPLORER("CEN","dividend_yield")=NZXPLORER.NZX_DSS("CEN")

40+ Available Metrics

Pass any of these as the second argument to NZX_EXPLORER(). Example: =NZXPLORER.NZX_EXPLORER("FPH", "roe")

Valuation

pe_ratiopb_ratioev_ebitdaprice_to_fcfprice_to_salesearnings_yield

Profitability

roeroanet_marginoperating_margingross_margin

Dividends

dividend_yieldpayout_ratiodpsdss_score

Leverage

debt_to_equitycurrent_ratiointerest_covernet_debt_to_ebitda

Growth

revenue_growthearnings_growthebitda_growthdividend_growth

Governance

grs_scoregrs_ratingboard_structure_scoreshareholder_rights_score

Insider

ics_score

Company

pricemarket_capsectordescription

Financial Statement Fields

Use with NZX_FINANCIALS(ticker, year, field). Values are in NZD thousands.

Income Statement

revenuenet_profitebitdaebitoperating_expensesgross_profit

Balance Sheet

total_assetstotal_liabilitiestotal_equitycash_and_equivalentstotal_borrowings

Cash Flow

operating_cash_flowinvesting_cash_flowfinancing_cash_flowcapexfree_cash_flow

Technical Details

How the add-in works under the hood.

Office.js Custom Functions

Built with the Office.js CustomFunctions API. Calls the NZXplorer REST API (v1) at nzxplorer.co.nz/api/v1/ using fetch(). Authenticated via X-API-Key header. Same API used by the MCP server and Copilot.

6-Hour Cache

Uses localStorage to cache API responses for 6 hours with TTL-based expiry. A 50-cell spreadsheet makes at most 50 API calls on first load, then zero until cache expires. Clear manually via the task pane.

Key in localStorage

Your API key is stored in the browser's localStorage, scoped to the add-in origin. It is not stored in the workbook and is not visible to users who open your shared spreadsheet.

Error Codes

ErrorMeaningFix
#NO_DATANo data available for this ticker/metric combinationCheck the ticker symbol and metric name are correct
#AUTH_ERRORAPI key is missing, invalid, or expiredOpen the NZXplorer task pane and enter your API key
#RATE_LIMITToo many API requests in the last minuteWait 60 seconds and recalculate
#NOT_FOUNDTicker not recognized or endpoint returned 404Verify the ticker is a current NZX-listed company
#INVALID_TICKEREmpty or non-string ticker argumentPass a valid ticker string, e.g. "FPH"
#API_ERRORServer error or network issueTry again in a few minutes

Frequently Asked Questions

How do I get an API key?

Sign up at nzxplorer.co.nz/auth and visit your account page. Free tier includes 10 API requests per minute, which is sufficient for most spreadsheet use. Pro ($29/mo) allows 100 requests/min for larger models.

How often does the data refresh?

Data is cached in localStorage for 6 hours to minimise API calls. Use the task pane "Clear Cache" button to force a refresh. Stock prices update daily; financials update when companies file.

What companies are supported?

All 130 NZX-listed companies are supported. Use standard NZX ticker symbols: FPH, AIR, SPK, MEL, CEN, MFT, etc. The ticker is case-insensitive.

What does "NZD thousands" mean for financial data?

Financial statement values (revenue, profit, assets, etc.) from NZX_FINANCIALS are in NZD thousands, matching the standard NZ annual report convention. A value of 1856000 means $1,856,000,000 ($1.856 billion). Divide by 1000 if you want raw dollars, or multiply by 1000 if you want actual NZD.

Why are functions prefixed with NZXPLORER?

Excel custom functions require a namespace prefix. All NZXplorer functions are under the NZXPLORER namespace, so you type =NZXPLORER.NZX_PRICE("FPH") instead of just =NZX_PRICE("FPH"). This avoids conflicts with other add-ins.

Does it work with Excel Online (web)?

Yes. Office.js custom functions work in Excel on Windows, Mac, and Excel for the web. The sideloading process may differ slightly between platforms. See Microsoft documentation for platform-specific instructions.

What happens if I exceed the rate limit?

Functions will return #RATE_LIMIT. The 6-hour cache means most spreadsheets make very few actual API calls. A sheet with 50 different formulas makes at most 50 calls on first load, then serves from cache. Wait 60 seconds and recalculate to retry.

Is the Insider Conviction Score (ICS) the same as on the website?

Yes. The ICS is computed from the last 30 insider trades using the same 4-component algorithm: buy/sell ratio (30pts), multi-director alignment (25pts), recency (25pts), and volume intensity (20pts). The calculation runs client-side in Excel.

How is this different from the Google Sheets add-on?

The functions are identical. The main differences are: (1) Excel functions are prefixed with NZXPLORER. (namespace), (2) caching uses localStorage instead of Google CacheService, (3) setup uses manifest sideloading instead of Apps Script. Both connect to the same NZXplorer API.

Ready to Add NZX Data to Excel?

Download the manifest, sideload it in Excel, and start using NZX functions in under 3 minutes. Free tier supports 10 requests per minute.

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.