NZXplorer Alerts API

Webhook, email, and Zapier alert subscriptions

GitHub OpenAPI

Operations 17

GET /alerts/subscriptions List Alert Subscriptions #
POST /alerts/subscriptions Create Alert Subscription #
POST /alerts/test Test Webhook Delivery #
GET /webhooks List Webhook Subscriptions #
POST /webhooks Create Webhook #
PUT /webhooks/{id} Update Webhook #
DELETE /webhooks/{id} Delete Webhook #
GET /webhooks/{id}/history Webhook Delivery History #
POST /webhooks/{id}/test Test Webhook #
GET /zapier/auth Zapier Auth Test #
POST /zapier/hooks Zapier: Subscribe REST Hook #
DELETE /zapier/hooks/{id} Zapier: Unsubscribe REST Hook #
GET /user-alerts List User Alerts #
POST /user-alerts Create User Alert #
GET /watchlist Watchlist Management #
GET /keyword-alerts Keyword Alerts #
GET /morning-brief Morning Brief #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nzxplorer-co-nz:nzxplorer-co-nz-alerts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nzxplorer-co-nz-alerts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NZXplorer Alerts API
  version: 1.157.0
  description: 'Comprehensive NZX market data, governance intelligence, and proxy advisory API covering 130 issuers on the New Zealand Exchange. Provides structured access to company fundamentals, director intelligence, insider trades, financial statements, ESG data, dividend analytics, proxy advisory reports, and more.


    All monetary values in financial statement endpoints (income_statements, balance_sheets, cash_flow_statements, earnings_results) are in NZD thousands unless otherwise noted. Dividends per share (dps_cents) are in cents. Ratios are unit-free percentages.'
  contact:
    name: NZXplorer API Support
    email: hello@nzxplorer.co.nz
    url: https://nzxplorer.co.nz/developers
  license:
    name: Proprietary
    url: https://nzxplorer.co.nz/terms
  x-logo:
    url: https://nzxplorer.co.nz/logo.png
servers:
- url: https://nzxplorer.co.nz/api/v1
  description: Production
security:
- ApiKeyHeader: []
- ApiKeyQuery: []
tags:
- name: Alerts
  description: Webhook, email, and Zapier alert subscriptions
paths:
  /alerts/subscriptions:
    get:
      operationId: getAlertsSubscriptions
      summary: List Alert Subscriptions
      description: List all alert subscriptions for the authenticated user. Also supports POST to create a new subscription. Subscriptions filter market signals and anomalies by tickers, sectors, signal types, anomaly categories, and severity — then deliver via webhook or email. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: List Alert Subscriptions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
    post:
      operationId: createAlertsSubscriptions
      summary: Create Alert Subscription
      description: 'Create a new alert subscription. Configure which signal types (11 types: insider_trade, capital_raise, dividend, earnings, agm_result, director_change, grs_change, technical_signal, credit_rating, audit_change, takeover) and anomaly categories (insider, governance, financial, market, agm, corporate) to monitor. Filter by tickers and/or sectors. Choose webhook or email delivery with realtime, daily, or weekly frequency. Webhook payloads are signed with HMAC-SHA256. Enterprise tier required.'
      tags:
      - Alerts
      x-tier: free
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Human-readable subscription name
                signal_types:
                  type: string
                  description: Signal types to include (11 available)
                anomaly_categories:
                  type: string
                  description: Anomaly categories to include (6 available)
                min_severity:
                  type: string
                  description: 'Minimum severity: low, medium, high, critical (default: low)'
                delivery_method:
                  type: string
                  description: 'Delivery method: webhook or email'
                delivery_frequency:
                  type: string
                  description: 'Frequency: realtime, daily, or weekly'
                webhook_url:
                  type: string
                  description: Webhook endpoint URL (required if delivery_method is webhook)
                webhook_secret:
                  type: string
                  description: Secret for HMAC-SHA256 signing of webhook payloads
                email_address:
                  type: string
                  description: Email address (required if delivery_method is email)
              required:
              - name
              - signal_types
              - delivery_method
              - delivery_frequency
      responses:
        '200':
          description: Create Alert Subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /alerts/test:
    post:
      operationId: testAlertsTest
      summary: Test Webhook Delivery
      description: Send a test alert payload to a subscription\
      tags:
      - Alerts
      x-tier: free
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_id:
                  type: number
                  description: ID of the subscription to test
              required:
              - subscription_id
      responses:
        '200':
          description: Test Webhook Delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /webhooks:
    get:
      operationId: listWebhooks
      summary: List Webhook Subscriptions
      description: List all webhook subscriptions for the authenticated user. Each subscription includes name, URL, event type filters (tickers, sectors, signal types), and active status. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: List Webhook Subscriptions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
    post:
      operationId: createWebhooks
      summary: Create Webhook
      description: Create a new webhook subscription with name, URL, and optional filters for tickers, sectors, and signal types. Payloads are signed with HMAC-SHA256. Supports 12 market event types (insider_trade, capital_raise, dividend, earnings, agm_result, director_change, grs_change, technical_signal, credit_rating, audit_change, takeover, board_event) and 6 board event types. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Human-readable webhook name
                url:
                  type: string
                  description: Webhook endpoint URL (must be HTTPS)
                filters:
                  type: string
                  description: 'Optional filters: { tickers: string[], sectors: string[], signal_types: string[] }'
              required:
              - name
              - url
      responses:
        '200':
          description: Create Webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /webhooks/{id}:
    put:
      operationId: updateWebhooks
      summary: Update Webhook
      description: Update an existing webhook subscription. Supports partial updates — only include the fields you want to change (name, url, filters, is_active). Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      parameters:
      - name: id
        in: path
        required: true
        description: Webhook subscription ID (path parameter)
        schema:
          type: string
      responses:
        '200':
          description: Update Webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
    delete:
      operationId: deleteWebhooks
      summary: Delete Webhook
      description: Permanently delete a webhook subscription and its delivery history. This action cannot be undone. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      parameters:
      - name: id
        in: path
        required: true
        description: Webhook subscription ID (path parameter)
        schema:
          type: string
      responses:
        '200':
          description: Delete Webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /webhooks/{id}/history:
    get:
      operationId: getWebhookHistory
      summary: Webhook Delivery History
      description: View delivery history for a specific webhook subscription. Shows success/failure status, HTTP response codes, and timestamps. Paginated. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      parameters:
      - name: id
        in: path
        required: true
        description: Webhook subscription ID
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: 'Results per page (default: 50)'
        schema:
          type: number
      - name: offset
        in: query
        required: false
        description: 'Pagination offset (default: 0)'
        schema:
          type: number
      responses:
        '200':
          description: Webhook Delivery History
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /webhooks/{id}/test:
    post:
      operationId: testWebhooksTest
      summary: Test Webhook
      description: Send a test payload to a webhook endpoint to verify it is reachable and correctly handles HMAC-SHA256 signed payloads. Returns delivery status. Enterprise tier required.
      tags:
      - Alerts
      x-tier: free
      parameters:
      - name: id
        in: path
        required: true
        description: Webhook subscription ID
        schema:
          type: string
      responses:
        '200':
          description: Test Webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /zapier/auth:
    get:
      operationId: getZapierAuth
      summary: Zapier Auth Test
      description: Verify API key during Zapier connection setup. Returns authenticated user email, tier, and key name. Used by Zapier during
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: Zapier Auth Test
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /zapier/hooks:
    post:
      operationId: createZapierHooks
      summary: 'Zapier: Subscribe REST Hook'
      description: Register a REST Hook for real-time event push. Zapier calls this when a Zap is turned on. Events are pushed to target_url during the cron dispatch cycle. Auto-deactivates on 410 Gone.
      tags:
      - Alerts
      x-tier: free
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                target_url:
                  type: string
                  description: Zapier webhook receiver URL
                event_type:
                  type: string
                  description: 'Event type: announcement, insider_trade, grs_change, dividend, capital_raise, director_change, earnings, composite_signal'
                tickers:
                  type: string
                  description: Ticker filter (empty = all)
                sectors:
                  type: string
                  description: Sector filter (empty = all)
              required:
              - target_url
              - event_type
      responses:
        '200':
          description: 'Zapier: Subscribe REST Hook'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /zapier/hooks/{id}:
    delete:
      operationId: deleteZapierHooks
      summary: 'Zapier: Unsubscribe REST Hook'
      description: Remove a REST Hook subscription. Zapier calls this when a Zap is turned off.
      tags:
      - Alerts
      x-tier: free
      parameters:
      - name: id
        in: path
        required: true
        description: Hook ID (path parameter)
        schema:
          type: string
      responses:
        '200':
          description: 'Zapier: Unsubscribe REST Hook'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /user-alerts:
    get:
      operationId: listUserAlerts
      summary: List User Alerts
      description: List all alert subscriptions for the logged-in user. Session-authenticated (cookie-based, not API key). Returns alert name, tickers, signal types, severity, and active status.
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: List User Alerts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
    post:
      operationId: createUserAlerts
      summary: Create User Alert
      description: 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.
      tags:
      - Alerts
      x-tier: free
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Human-readable alert name
                tickers:
                  type: string
                  description: NZX ticker symbols (empty = all companies)
                signal_types:
                  type: string
                  description: Event types to monitor (empty = all types)
                min_severity:
                  type: string
                  description: 'Minimum severity: low, medium, high, critical (default: medium)'
              required:
              - name
      responses:
        '200':
          description: Create User Alert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /watchlist:
    get:
      operationId: listWatchlist
      summary: Watchlist Management
      description: Manage your company watchlists. GET lists all watchlists for the authenticated user. POST creates a new watchlist with up to 50 tickers.
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: Watchlist Management
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /keyword-alerts:
    get:
      operationId: listKeywordAlerts
      summary: Keyword Alerts
      description: Manage keyword alerts that scan NZX announcements. GET lists alerts with optional match history. POST creates a new alert with up to 20 keywords.
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: Keyword Alerts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /morning-brief:
    get:
      operationId: listMorningBrief
      summary: Morning Brief
      description: Your daily intelligence digest for watched companies. Returns overnight announcements, insider trades, price moves, dividends, and governance changes. Use ?generate=true to generate today\
      tags:
      - Alerts
      x-tier: free
      responses:
        '200':
          description: Morning Brief
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          headers:
            $ref: '#/components/headers/RateLimitHeaders'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Missing API key
            message: Include your API key via X-API-Key header or ?api_key= query parameter.
            docs: https://nzxplorer.co.nz/developers
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Rate limit exceeded
            message: free tier allows 10 requests/minute.
            retry_after_seconds: 45
      headers:
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Maximum requests allowed per minute
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Always 0 when rate limited
          schema:
            type: integer
  schemas:
    Envelope:
      type: object
      description: Standard API response envelope
      properties:
        data:
          description: Response payload
        meta:
          type: object
          properties:
            api_version:
              type: string
              example: v1
            timestamp:
              type: string
              format: date-time
            format:
              type: string
              enum:
              - standard
              - llm
              - fdc3
              - toon
            endpoint:
              type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Human-readable explanation
          nullable: true
        docs:
          type: string
          format: uri
          description: Link to API documentation
          nullable: true
        retry_after_seconds:
          type: integer
          description: Seconds to wait before retrying (rate limit only)
          nullable: true
      required:
      - error
  headers:
    RateLimitHeaders:
      X-RateLimit-Limit:
        description: Maximum requests allowed per minute
        schema:
          type: integer
      X-RateLimit-Remaining:
        description: Requests remaining in current window
        schema:
          type: integer
      X-RateLimit-Reset:
        description: Unix timestamp when the rate limit window resets
        schema:
          type: integer
      X-RateLimit-Limit-Day:
        description: Maximum requests allowed per day
        schema:
          type: integer
      X-RateLimit-Remaining-Day:
        description: Requests remaining for today
        schema:
          type: integer
      X-API-Tier:
        description: Authenticated API key tier (free, pro, enterprise, institutional)
        schema:
          type: string
      X-Request-ID:
        description: Unique request ID (UUID v4) for support correlation
        schema:
          type: string
          format: uuid
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key passed via the X-API-Key header
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: API key passed as a query parameter