---
title: "Portfolio Summary Widget"
method: GET
path: "/widgets/portfolio-summary"
tags: ["Widgets"]
---

# Portfolio Summary Widget

`GET /widgets/portfolio-summary`

## Request

- Base URL: `https://nzxplorer.co.nz/api/v1`
- URL: `https://nzxplorer.co.nz/api/v1/widgets/portfolio-summary`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

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.

## Query parameters

- `format` string
- `theme` string

## Response `200`

Portfolio Summary Widget

- Envelope: Standard API response envelope
  - `data` unknown
  - `meta` object
    - `api_version` string
    - `timestamp` string, date-time
    - `format` 'standard' | 'llm' | 'fdc3' | 'toon'
    - `endpoint` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/nzxplorer/apis/nzxplorer-api.md) · [All operations](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/revisions/f3b95341783a?raw)