Docs menu
NZ Herald API endpoint
NZ Herald top stories API
Returns the current New Zealand Herald top stories, with no parameters. Each item has a title and URL, and may include summary, author, publication time and image. Use `nzherald-headlines` to read one section.
GETapiKey1 credit/requestNZ Heraldpublicnews.newsResponseDoc
NZ Herald/nzherald/newsEndpoint facts
- Method
- GET
- API path
- /nzherald/news
- Auth
- apiKey
- Credits
- 1 credit/request
- Charged on
- Successful 2xx responses only
- Platform
- NZ Herald
- Response schema
- #/definitions/publicnews.newsResponseDoc
How this endpoint behaves
Returns fresh public New Zealand Herald top stories from its public homepage.
Sampled response
- Request, 14 Oct 2026
- GET /nzherald/news
- Items in items
- 48
- Fields filled in every checked item
- 2
| Field | Filled in, of 48 checked | Values in the sample |
|---|---|---|
| title | 48 | median 63 characters |
| url | 48 | nzherald.co.nz |
Request parameters
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| x-api-key (header) | string | Yes | API key required |
cURL example
curl -X GET "https://api.crawlora.net/api/v1/nzherald/news" \ -H "x-api-key: $CRAWLORA_API_KEY"
Example JSON response
{
"code": 200,
"data": {
"items": [
{
"title": "Example NZ Herald headline",
"url": "https://www.nzherald.co.nz/nz/example-article-slug/ABCDEFGHIJKLMNOPQRST1234/"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/publicnews.newsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| data | newsplatform.NewsResponse | No | ||||
| data.items | array | No | ||||
| data.items[].author | string | No | ||||
| data.items[].image_url | string | No | ||||
| data.items[].published_at | string | No | ||||
| data.items[].summary | string | No | ||||
| data.items[].title | string | No | ||||
| data.items[].type | string | No | ||||
| data.items[].url | string | No |
Failure responses
| Status | Description | Schema |
|---|---|---|
| 429 | Too Many Requests | #/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/news" \
-H "x-api-key: $CRAWLORA_API_KEY"