# NZX — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access daily stock data including open, high, low, close prices and trading volume for NZX-listed companies. Browse company listings and view detailed instrument information for stocks traded on the New Zealand Exchange.

**Category:** Finance & Markets | **Website:** [nzx.com/](https://nzx.com/) | **Docs:** [parse.bot/marketplace/5307e44f-7907-4475-acd7-18581a426633/nzx-com-api](https://parse.bot/marketplace/5307e44f-7907-4475-acd7-18581a426633/nzx-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/nzx/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get daily price volume

Get daily price and volume data for an NZX-listed stock. Returns up to 2 years of merged OHLC price data and trading volume/value for every trading day, sorted newest first. Each record includes open, high, low, close, market_price, volume, value, trade_count, on/off market volume, and capitalisation. The code is resolved to an ISIN internally before fetching metrics.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `code` | string | Yes | NZX stock ticker code (e.g. MHJ, AIR, FPH, FBU) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nzx/get-daily-price-volume \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"<string>"}'
```

### Get instrument details

Get detailed instrument information for an NZX stock code, including ISIN, security class, market type, category, currency, shares issued, and first listed date. A single ticker code may resolve to multiple instruments (e.g. ordinary shares plus warrants).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `code` | string | Yes | NZX stock ticker code (e.g. MHJ, AIR, FPH) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nzx/get-instrument-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"<string>"}'
```

### List companies

List all companies listed on the NZX, including their ticker codes, names, listing status, and first listed date. Results are sorted alphabetically by ticker code. No parameters required; returns the full directory in a single response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/nzx/list-companies \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.