Quickstart

Welcome to the News API quickstart guide. In this guide, we will walk you through the process of using the News API to retrieve news articles from various sources.

Obtaining an API Key

Before you can use the News API, you will need to obtain an API key. Please refer to the API Key documentation for instructions on how to get your API key. Make sure to keep your API key secure, as it can be used to make requests on your behalf and could potentially be misused if it falls into the wrong hands.

Making a Request

Once you have obtained your API key, you can start making requests to the News API. Here's an example request to retrieve the top headlines from BBC News:

curl -X GET
  'https://api.example.com/v2/articles?source=bbc-news&sortBy=popularity'
  -H 'Authorization: Bearer YOUR_API_KEY'

In this example, replace YOUR_API_KEY with your actual API key.

Response

The News API returns news articles in a JSON format that includes the article's source, author, title, description, URL, URL to image, published date, and content. Here's an example response for the request made in the previous section:

{
  "status": "ok",
  "totalResults": 20,
  "articles": [
    {
      "source": {
        "id": "bbc-news",
        "name": "BBC News"
      },
      "author": "BBC News",
      "title": "Example Article Title",
      "description": "Example article description.",
      "url": "https://example.com/article",
      "urlToImage": "https://example.com/article-image.jpg",
      "publishedAt": "2023-04-10T12:34:56Z",
      "content": "Example article content."
    },
    ...
  ]
}

That's it! You have successfully made a request to the News API and received a response containing news articles. For more information on the available parameters and endpoints, please refer to the API documentation.

Conclusion

In this quickstart guide, we showed you how to obtain an API key, make a request to the News API, and receive a response containing news articles. We hope this guide has been helpful in getting you started with the News API

What's next

1. Want to learn how to query articles efficiently? Learn about querying
2. List of possible errors and how to handle them. Error handling guide