Market Intelligence

Announcement Sentiment

AI-scored sentiment analysis of company announcements. Returns per-announcement sentiment scores, confidence, hedging levels, buried risks, key topics, and guidance direction. Includes company-level summary with average score and sentiment breakdown.

get/sentiment/{ticker}

Request

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

Path parameters

tickerstring required

NZX ticker symbol (e.g., AIR, FPH, SPK)

Query parameters

sentimentstring

Filter by sentiment: positive, negative, neutral, mixed

hedgingstring

Filter by hedging level: none, low, moderate, heavy

fromstring

Start date (YYYY-MM-DD)

tostring

End date (YYYY-MM-DD)

Response

Announcement Sentiment

dataunknown

Example response

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

Changes

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