Skip to main content

GET /api/news

Retrieve a list of all news articles about Dzaleka Refugee Camp.

Query Parameters

This endpoint does not require any query parameters.

Response Format

string
required
Status of the API response (“success” or “error”)
number
required
Total number of news articles returned
object
required
Container for the news data
array
required
Array of news article objects
string
Unique identifier for the article
string
Collection name (“news”)
string
Article title
string
Article summary or excerpt
string
URL to article featured image
string
Author name
Whether the article is featured
string
Publication date (YYYY-MM-DD)
string
Article category (e.g., “business-spotlight”, “community-update”, “announcement”)

Error Responses

string
“error”
string
Error message description
string
Detailed error information
Status Codes:
  • 200 - Success
  • 429 - Rate limit exceeded (60 requests per minute)
  • 500 - Internal server error

Rate Limiting

All API endpoints are rate-limited to 60 requests per minute per IP address. Rate limit headers are included in responses:
  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Timestamp when the rate limit resets
  • Retry-After: Seconds to wait before retrying (only on 429 responses)

Example Request

Example Response

POST /api/news

Retrieve news data with optional metadata and statistics.

Request Body

object
Optional configuration for the response
boolean
Include export metadata in response
boolean
Include statistics in response

Response Format

Same as GET endpoint, with optional additional fields:
object
Export metadata (only if includeMetadata: true)
string
ISO 8601 timestamp of export
string
Collection name
object
Statistics (only if includeStats: true)
number
Total number of items
string
Collection name

Example Request

Example Response

Implementation

The News API is implemented using the createGetHandler and createPostHandler utility functions from src/utils/api-utils.ts:118. Source code: src/pages/api/news.ts:5