Market Intelligence

Create Announcement Alert Rule

Create a new announcement alert rule. When matching announcements are published, notifications are delivered via your chosen method. keyword_match_mode controls whether any or all keywords must match.

post/announcement-alerts

Request

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

Request body

namestring required

Human-readable rule name

keywordsstring required

Keywords or phrases to match in announcements

tickersstring

NZX tickers to monitor (empty = all)

sectorsstring

Sectors to monitor (empty = all)

announcement_typesstring

Announcement types to monitor (e.g. FLLYR, GENERAL, SHINTR)

is_active'true' | 'false'

Whether the rule is active (default: true)

Response

Create Announcement Alert Rule

dataunknown

Example response

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

Changes

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