Alerts

Create User Alert

Create a new alert subscription for the logged-in user. Supports 12 signal types, ticker filtering, severity levels, and email delivery. Maximum 20 alerts per user. Session-authenticated.

post/user-alerts

Request

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

Request body

namestring required

Human-readable alert name

tickersstring

NZX ticker symbols (empty = all companies)

signal_typesstring

Event types to monitor (empty = all types)

min_severitystring

Minimum severity: low, medium, high, critical (default: medium)

Response

Create User Alert

dataunknown

Example response

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

Changes

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