---
title: "Keyword Alerts"
method: GET
path: "/keyword-alerts"
tags: ["Alerts"]
---

# Keyword Alerts

`GET /keyword-alerts`

## Request

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

Manage keyword alerts that scan NZX announcements. GET lists alerts with optional match history. POST creates a new alert with up to 20 keywords.

## Response `200`

Keyword Alerts

- 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)