Market Intelligence

Semantic Search

AI-powered search across 64,000+ NZX announcements. Supports 3 modes: keyword (BM25 FTS), semantic (pgvector cosine similarity), and hybrid (RRF fusion of both). Optional Cohere reranking for maximum relevance.

get/semantic-search

Request

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

Query parameters

qstring required

Search query (natural language)

modestring

Search mode: keyword, semantic (default), hybrid

rerank'true' | 'false'

Enable Cohere reranking (default false)

issuer_idnumber

Filter by company ID

typestring

Filter by announcement type (e.g. FLLYR, HALFYR)

fromstring

Start date (YYYY-MM-DD)

tostring

End date (YYYY-MM-DD)

limitnumber

Max results (default 20)

thresholdnumber

Min similarity score 0-1 (default 0.5)

Response

Semantic Search

dataunknown

Example response

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

Changes

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