NZXplorer Widgets API
Embeddable widgets and portfolio management
Embeddable widgets and portfolio management
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nzxplorer-co-nz:nzxplorer-co-nz-widgets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NZXplorer Widgets API
version: 1.157.0
description: 'Comprehensive NZX market data, governance intelligence, and proxy advisory API covering 130 issuers on the New Zealand Exchange. Provides structured access to company fundamentals, director intelligence, insider trades, financial statements, ESG data, dividend analytics, proxy advisory reports, and more.
All monetary values in financial statement endpoints (income_statements, balance_sheets, cash_flow_statements, earnings_results) are in NZD thousands unless otherwise noted. Dividends per share (dps_cents) are in cents. Ratios are unit-free percentages.'
contact:
name: NZXplorer API Support
email: hello@nzxplorer.co.nz
url: https://nzxplorer.co.nz/developers
license:
name: Proprietary
url: https://nzxplorer.co.nz/terms
x-logo:
url: https://nzxplorer.co.nz/logo.png
servers:
- url: https://nzxplorer.co.nz/api/v1
description: Production
security:
- ApiKeyHeader: []
- ApiKeyQuery: []
tags:
- name: Widgets
description: Embeddable widgets and portfolio management
paths:
/widgets/{type}:
get:
operationId: getWidget
summary: Embeddable Widgets
description: 'Pre-built data widgets for embedding on third-party websites. 8 widget types: price-card, governance-badge, dividend-history, insider-activity, financials-summary, company-overview, sector-heatmap, portfolio-summary. Pro+ tier required.'
tags:
- Widgets
x-tier: free
parameters:
- name: type
in: path
required: true
description: 'Widget type: price-card, governance-badge, dividend-history, insider-activity, financials-summary, company-overview, sector-heatmap, portfolio-summary'
schema:
type: string
- name: ticker
in: query
required: false
description: NZX ticker symbol (required for all types except sector-heatmap and portfolio-summary)
schema:
type: string
- name: period
in: query
required: false
description: 'Performance period for sector-heatmap: 1w (default) or 1m'
schema:
type: string
responses:
'200':
description: Embeddable Widgets
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/portfolio/import-csv:
post:
operationId: importPortfolioImportCsv
summary: Portfolio CSV Import
description: 'Import portfolio holdings from a broker CSV export. Auto-detects Sharesies, Sharesight, and Hatch formats. Cleans tickers (.NZ suffix, NZX: prefix), validates 2-5 char codes. Use merge=true to add new tickers without replacing existing holdings.'
tags:
- Widgets
x-tier: free
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
csv:
type: string
description: CSV file contents as a string (header + data rows)
platform:
type: string
description: 'Force platform: sharesies, sharesight, hatch, auto (default: auto-detect from headers)'
merge:
type: string
enum:
- 'true'
- 'false'
description: 'If true, add new tickers only (skip existing). Default: false (replace all)'
required:
- csv
responses:
'200':
description: Portfolio CSV Import
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/widgets/portfolio-summary:
get:
operationId: getWidgetsPortfolioSummary
summary: Portfolio Summary Widget
description: Embeddable portfolio summary widget. Returns HTML snippet or JSON data for your portfolio holdings, P&L, governance scores, and sector exposure. Use format=html for iframe embedding on blogs/sites.
tags:
- Widgets
x-tier: free
parameters:
- name: format
in: query
required: false
description: 'Response format: html (default) or json'
schema:
type: string
- name: theme
in: query
required: false
description: 'Widget theme: light (default) or dark'
schema:
type: string
responses:
'200':
description: Portfolio Summary Widget
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/portfolio:
get:
operationId: listPortfolio
summary: Get Portfolio
description: Returns the authenticated user\
tags:
- Widgets
x-tier: free
responses:
'200':
description: Get Portfolio
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
post:
operationId: createPortfolio
summary: Add/Sync Holdings
description: 'Add a single holding or bulk sync all holdings. Single: send {ticker, shares_held?, avg_cost_nzd?, weight?}. Bulk: send {holdings: [...]} to replace all holdings. Max 100 holdings.'
tags:
- Widgets
x-tier: free
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ticker:
type: string
description: NZX ticker (for single add)
shares_held:
type: number
description: Number of shares held
avg_cost_nzd:
type: number
description: Average cost per share in NZD
weight:
type: number
description: Target allocation weight (0-100)
holdings:
type: string
description: Array of holdings for bulk sync
responses:
'200':
description: Add/Sync Holdings
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/portfolio/enriched:
get:
operationId: getPortfolioEnriched
summary: Enriched Portfolio
description: Returns the user\
tags:
- Widgets
x-tier: free
responses:
'200':
description: Enriched Portfolio
content:
application/json:
schema:
$ref: '#/components/schemas/Envelope'
headers:
$ref: '#/components/headers/RateLimitHeaders'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
components:
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Missing API key
message: Include your API key via X-API-Key header or ?api_key= query parameter.
docs: https://nzxplorer.co.nz/developers
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RateLimited:
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Rate limit exceeded
message: free tier allows 10 requests/minute.
retry_after_seconds: 45
headers:
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
X-RateLimit-Limit:
description: Maximum requests allowed per minute
schema:
type: integer
X-RateLimit-Remaining:
description: Always 0 when rate limited
schema:
type: integer
schemas:
Envelope:
type: object
description: Standard API response envelope
properties:
data:
description: Response payload
meta:
type: object
properties:
api_version:
type: string
example: v1
timestamp:
type: string
format: date-time
format:
type: string
enum:
- standard
- llm
- fdc3
- toon
endpoint:
type: string
ErrorResponse:
type: object
properties:
error:
type: string
description: Error message
message:
type: string
description: Human-readable explanation
nullable: true
docs:
type: string
format: uri
description: Link to API documentation
nullable: true
retry_after_seconds:
type: integer
description: Seconds to wait before retrying (rate limit only)
nullable: true
required:
- error
headers:
RateLimitHeaders:
X-RateLimit-Limit:
description: Maximum requests allowed per minute
schema:
type: integer
X-RateLimit-Remaining:
description: Requests remaining in current window
schema:
type: integer
X-RateLimit-Reset:
description: Unix timestamp when the rate limit window resets
schema:
type: integer
X-RateLimit-Limit-Day:
description: Maximum requests allowed per day
schema:
type: integer
X-RateLimit-Remaining-Day:
description: Requests remaining for today
schema:
type: integer
X-API-Tier:
description: Authenticated API key tier (free, pro, enterprise, institutional)
schema:
type: string
X-Request-ID:
description: Unique request ID (UUID v4) for support correlation
schema:
type: string
format: uuid
securitySchemes:
ApiKeyHeader:
type: apiKey
in: header
name: X-API-Key
description: API key passed via the X-API-Key header
ApiKeyQuery:
type: apiKey
in: query
name: api_key
description: API key passed as a query parameter