Widgets

Add/Sync Holdings

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.

post/portfolio

Request

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

Request body

tickerstring

NZX ticker (for single add)

shares_heldnumber

Number of shares held

avg_cost_nzdnumber

Average cost per share in NZD

weightnumber

Target allocation weight (0-100)

holdingsstring

Array of holdings for bulk sync

Response

Add/Sync Holdings

dataunknown

Example response

{
  "meta": {
    "api_version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.