Docs menu
Punch API endpoint
Punch article API
Returns a Punch article by canonical `url` (`https://punchng.com/<slug>/`): title, description, publication and update times, section, authors, image and the body `paragraphs`. Punch articles are free to read, so `paywalled` is never set. Video-led stories may have only a short text summary.
GETapiKey2 credits/requestPunchpublicnews.articleResponseDoc
Punch/punch/articleEndpoint facts
- Method
- GET
- API path
- /punch/article
- Auth
- apiKey
- Credits
- 2 credits/request
- Charged on
- Successful 2xx responses only
- Platform
- Punch
- Response schema
- #/definitions/publicnews.articleResponseDoc
How this endpoint behaves
Query parameter: url is a canonical HTTPS punchng.com article URL in the form https://punchng.com/<slug>/. Returns public metadata (title, description, publish and update time, section, authors, image) and the full body paragraphs. Punch articles are free to read; paywalled is never set. Video-led stories (the video section) may have only a short text summary.
Sampled response
- Request, 14 Oct 2026
- GET /punch/article?url=https%3A%2F%2Fpunchng.com%2Fex-lagos-commissioner-urges-town-planners-to-embrace-collaboration%2F
- Fields returned with a value
- 8
| Field | In the sample | Value in the sample |
|---|---|---|
| url | Has a value | punchng.com |
| title | Has a value | 66 characters |
| published_at | Has a value | 2026-09-24 |
| updated_at | Has a value | 2026-09-24 |
| section | Has a value | “News” |
| authors | Has a value | 1 entry |
| image_url | Has a value | cdn.punchng.com |
| paragraphs | Has a value | 22 entries |
Request parameters
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Canonical Punch article URL | https://punchng.com/example-article-slug/ | |
| x-api-key (header) | string | Yes | API key required |
cURL example
curl -X GET "https://api.crawlora.net/api/v1/punch/article?url=https%3A%2F%2Fpunchng.com%2Fexample-article-slug%2F" \ -H "x-api-key: $CRAWLORA_API_KEY"
Example JSON response
{
"code": 200,
"data": {
"url": "https://punchng.com/ex-lagos-commissioner-urges-town-planners-to-embrace-collaboration/",
"title": "Ex-Lagos commissioner urges town planners to embrace collaboration",
"published_at": "2026-09-24T20:25:14Z",
"section": "News",
"authors": [
"Taiwo Bankole"
],
"paragraphs": [
"A town planning expert and former Lagos State Commissioner ..."
]
}
}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 |
| 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/punch/article?url=https%3A%2F%2Fpunchng.com%2Fexample-article-slug%2F" \
-H "x-api-key: $CRAWLORA_API_KEY"