Docs menu
NZ Herald API endpoint
NZ Herald article API
Returns public NZ Herald article metadata and body paragraphs from a canonical article URL. A premium (subscriber-only) article URL returns a permission error instead of a partial or fabricated body.
GETapiKey2 credits/requestNZ Heraldpublicnews.articleResponseDoc
NZ Herald/nzherald/articleEndpoint facts
- Method
- GET
- API path
- /nzherald/article
- Auth
- apiKey
- Credits
- 2 credits/request
- Charged on
- Successful 2xx responses only
- Platform
- NZ Herald
- Response schema
- #/definitions/publicnews.articleResponseDoc
How this endpoint behaves
Query parameter: url is a canonical HTTPS www.nzherald.co.nz article URL
in the form /<section-path>/<slug>/<id>/. Returns public metadata and body
paragraphs.
A premium (subscriber-only) article's URL carries a literal /premium/
segment immediately before its id (for example
/business/markets/shares/example-story/premium/ABCDEFGHIJKLMNOPQRST1234/).
That shape returns a 403 permission error instead of a partial or fabricated
body -- no free content is available for a premium article through this
endpoint.
Sampled response
- Request, 14 Oct 2026
- GET /nzherald/article?url=https%3A%2F%2Fwww.nzherald.co.nz%2Fbusiness%2Fit-took-20-years-to-start-regulating-social-media-will-ai-controls-come-sooner%2FNZYHPBFXRNCU3I3QDEYL6ZYKBM%2F
- Fields returned with a value
- 9
| Field | In the sample | Value in the sample |
|---|---|---|
| url | Has a value | nzherald.co.nz |
| title | Has a value | 81 characters |
| description | Has a value | 77 characters |
| published_at | Has a value | 2026-09-24 |
| updated_at | Has a value | 2026-09-24 |
| section | Has a value | “Business” |
| authors | Has a value | 1 entry |
| image_url | Has a value | cloudfront-ap-southeast-2.images.arcpublishing.com |
| paragraphs | Has a value | 25 entries |
Request parameters
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Canonical NZ Herald article URL | https://www.nzherald.co.nz/nz/example-article-slug/ABCDEFGHIJKLMNOPQRST1234/ | |
| x-api-key (header) | string | Yes | API key required |
cURL example
curl -X GET "https://api.crawlora.net/api/v1/nzherald/article?url=https%3A%2F%2Fwww.nzherald.co.nz%2Fnz%2Fexample-article-slug%2FABCDEFGHIJKLMNOPQRST1234%2F" \ -H "x-api-key: $CRAWLORA_API_KEY"
Example JSON response
{
"code": 200,
"data": {
"url": "https://www.nzherald.co.nz/nz/example-article-slug/ABCDEFGHIJKLMNOPQRST1234",
"title": "Example article",
"section": "New Zealand",
"paragraphs": [
"Example public paragraph."
]
}
}Request schema
No body schema
Response schema
#/definitions/publicnews.articleResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| data | newsplatform.ArticleResponse | No | ||||
| data.authors | array | No | ||||
| data.description | string | No | ||||
| data.image_url | string | No | ||||
| data.paragraphs | array | No | ||||
| data.paywalled | boolean | No | Paywalled is true when the publisher serves only a teaser of this article to anonymous readers, so Paragraphs is a partial body rather than the full text. It is omitted when the full public body was returned. | |||
| data.published_at | string | No | ||||
| data.section | string | No | ||||
| data.title | string | No | ||||
| data.updated_at | string | No | ||||
| data.url | string | No |
Failure responses
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 403 | Forbidden | #/definitions/app.Response |
| 404 | Not Found | #/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/article?url=https%3A%2F%2Fwww.nzherald.co.nz%2Fnz%2Fexample-article-slug%2FABCDEFGHIJKLMNOPQRST1234%2F" \
-H "x-api-key: $CRAWLORA_API_KEY"