Docs menu
NZ Herald API endpoint
NZ Herald section headlines API
Returns recent NZ Herald headlines for one section. `section` is required and takes a slug listed by `nzherald-sections`, such as `nz`, `business`, `rugby`, `politics` or `world`. Each item has a title and URL. A URL may point at a premium article, which `nzherald-article` rejects with a permission error.
GETapiKey1 credit/requestNZ Heraldpublicnews.headlinesResponseDoc
NZ Herald/nzherald/headlinesEndpoint facts
- Method
- GET
- API path
- /nzherald/headlines
- Auth
- apiKey
- Credits
- 1 credit/request
- Charged on
- Successful 2xx responses only
- Platform
- NZ Herald
- Response schema
- #/definitions/publicnews.headlinesResponseDoc
How this endpoint behaves
Query parameter: section is required and must be one of business, markets-with-madison, media-insider, business-reports, small-business, personal-finance, economy, companies, markets, entertainment, lifestyle, society-insider, nz, crime, education, politics, trailblazers, property, sport, commonwealth-games, cricket, olympics, paralympics, rugby, rugby-league, football, basketball, golf, boxing, netball, athletics, cycling, motorsport, racing, sailing, tennis, ufc, technology, travel, travel-news, world, kahu, talanoa, or the-selection.
A listed headline's URL may point at a premium (subscriber-only) article; the
headline itself is always public, but fetching its full body through
nzherald-article returns a permission error for a premium URL.
Sampled response
- Request, 14 Oct 2026
- GET /nzherald/headlines?section=business
- Items in items
- 10
- Fields filled in every checked item
- 6
| Field | Filled in, of 10 checked | Values in the sample |
|---|---|---|
| title | 10 | median 79 characters |
| url | 10 | nzherald.co.nz |
| summary | 10 | median 80 characters |
| published_at | 10 | 2026-10-13 |
| author | 10 | |
| image_url | 10 | nzherald.co.nz |
Request parameters
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| section | string | Yes | NZ Herald section slug Allowed values: business, markets-with-madison, media-insider, business-reports, small-business, personal-finance, economy, companies, markets, entertainment, lifestyle, society-insider, nz, crime, education, politics, trailblazers, property, sport, commonwealth-games, cricket, olympics, paralympics, rugby, rugby-league, football, basketball, golf, boxing, netball, athletics, cycling, motorsport, racing, sailing, tennis, ufc, technology, travel, travel-news, world, kahu, talanoa, the-selection. | business | |
| x-api-key (header) | string | Yes | API key required |
cURL example
curl -X GET "https://api.crawlora.net/api/v1/nzherald/headlines?section=business" \ -H "x-api-key: $CRAWLORA_API_KEY"
Example JSON response
{
"code": 200,
"data": {
"section": "nz",
"items": [
{
"title": "Example headline",
"url": "https://www.nzherald.co.nz/nz/example-article-slug/ABCDEFGHIJKLMNOPQRST1234/"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/publicnews.headlinesResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| data | newsplatform.HeadlinesResponse | No | ||||
| data.items | array | No | HeadlineItem record, 7 fields: author, image_url, published_at, summary, title, type, url. Described under NZ Herald top stories API. | |||
| data.section | string | No |
Failure responses
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Code examples
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/nzherald/headlines?section=business" \
-H "x-api-key: $CRAWLORA_API_KEY"