Market Intelligence

List Announcement Alert Matches

List announcements that matched a specific alert rule. Returns matched announcements with the keywords that triggered the match.

get/announcement-alerts/{id}/matches

Request

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

Path parameters

idstring required

Alert rule ID (path parameter)

Query parameters

limitinteger

Results per page (default: 50)

offsetinteger

Pagination offset (default: 0)

Response

List Announcement Alert Matches

dataunknown

Example response

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

Changes

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