Screener

Financial Screener

Screen 131 NZX stocks across 200+ metrics. Smart presets, custom filters, sorting. The

get/screener

Request

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

Query parameters

presetstring

Smart preset: value, growth, quality, oversold, overbought, golden_cross, below_200ma, death_cross, dividend_risk, dividend_aristocrats, low_volatility, turnaround, small_cap_gems, insider_buying, capital_raise, ceo_pay_failure, governance_laggards, income_portfolio, conservative_growth, esg_compliant

sectorstring

Filter by sector

qstring

Search by company name or ticker

sortstring

Sort by any of 90 columns (e.g., rsi_14, pe_ratio, grs_score, return_1y, sentiment_score, next_results_days)

orderstring

Sort direction: asc or desc (default: desc)

yearstring

Fiscal year (default: latest per company)

limitinteger

Results per page, max 500 (default: 50)

offsetinteger

Pagination offset (default: 0)

Response

Financial Screener

dataunknown

Example response

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

Changes

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