NZXplorer System API

Health checks and system status

GitHub OpenAPI

Operations 1

GET /health API health check #

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-system-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-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NZXplorer System 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: System
  description: Health checks and system status
paths:
  /health:
    get:
      operationId: healthCheck
      summary: API health check
      description: Returns pass/fail status for each core data table. No authentication required.
      tags:
      - System
      x-tier: free
      security: []
      responses:
        '200':
          description: Health status
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - down
                  checks:
                    type: object
                    additionalProperties:
                      type: string
                      enum:
                      - pass
                      - fail
                  timestamp:
                    type: string
                    format: date-time
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    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
  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