API Documentation

Request Body object

Success Response example:

{
    "current_page": 1,
    "data": [
        {
            "title": "The New York Times",
            "description": "A small description of the website.",
            "url": "https://www.nytimes.com",
            "image_url": "https://www.nytimes.com/image.png",
            "published_at": "2020-01-01T00:00:00.000000Z",
            "category": "business",
            "country": "united-arab-emirates",
            "domain": "www.nytimes.com",
        }
    ],
    "first_page_url": "http://localhost:8000/api/v1/news?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v1/news?page=1",
    "next_page_url": null,
    "path": "http://localhost:8000/api/v1/news",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1,
    "error": null,
    "credits_left": 23
}

Error Response example:

{
    "data": [],
    "error": "No credit left to use",
    "credits_left": 0
}

Error Response if you hit the rate limit:

{
    "message": "Too many requests.",
}