---
title: "Financial Screener"
method: GET
path: "/screener"
tags: ["Screener"]
---

# Financial Screener

`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`

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

## Query parameters

- `preset` string
- `sector` string
- `q` string
- `sort` string
- `order` string
- `year` string
- `limit` integer
- `offset` integer

## Response `200`

Financial Screener

- Envelope: Standard API response envelope
  - `data` unknown
  - `meta` object
    - `api_version` string
    - `timestamp` string, date-time
    - `format` 'standard' | 'llm' | 'fdc3' | 'toon'
    - `endpoint` string

## Other responses

- `401`: Missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/nzxplorer/apis/nzxplorer-api.md) · [All operations](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nzxplorer/apis/nzxplorer-api/revisions/f3b95341783a?raw)