---

newsapi

---

|version| |license| |wheel| |implementation|

Python wrapper around A JSON API for live news and blog headlines (a.k.a. News Api): https://newsapi.org/

NOTE: This library and its author are not endorsed by or affiliated with NewsApi.org <https://newsapi.org/>_.

Installation

Using pip:

::

pip install newsapi

Dependencies

• requests

API

newsapi offers two classes Articles and Sources for the functionality of two endpoints:- https://newsapi.org/v1/articles and https://newsapi.org/v1/sources offered by News Api respectively.

Articles

================= ================== ============================ =================================================================== News API Param newsapi Param Value Description ================= ================== ============================ =================================================================== source source string (required) The identifer for the news source or blog you want headlines from apiKey API_KEY string (required) Your API key. sortBy sort_by string (optional) Specify which type of list you want. The possible options are top, latest and popular. Note: not all options are available for all sources. Default: top. ================= ================== ============================ ===================================================================

Methods

All methods of Articles are accessible via:

.. code-block:: python

from newsapi.articles import articles

a = Articles(API_KEY="Your-api-key")

a.<method>

===================================== ================================================================================== ============================================================================================ ================= Method Parameters Description Returns ===================================== ================================================================================== ============================================================================================ ================= get() source (required), sort_by (optional), attributes_format (optional Default:True) Generic request to NewsApi (with source as required parameter, sort_by as optional). AttrDict get_by_top() source (required) Requests a list of the source's headlines sorted in the order they appear on its homepage. AttrDict get_by_latest() source (required). Requests a list of the source's headlines sorted in chronological order, newest first. AttrDict get_by_popular() source (required). Requests a list of the source's current most popular or currently trending headlines. AttrDict ===================================== ================================================================================== ============================================================================================ =================

NOTE: By default all newsapi responses are formatted as JSON, AttrDict is just a wrapper around Dictionary which enables to do content.status as well as content['status'], but can't do it in nested dicts.

Usage

General Import

.. code-block:: python

from newsapi.articles import Articles

a = Articles(API_KEY="Your-api-key")

a.get()

.. code-block:: python

# get all the articles from the new web and sorted by top (default).
a.get(source="the-new-web")

a.get_by_popular()

.. code-block:: python

# get all the articles from the new web and sorted by popular (front page).
a.get_by_popular(source="the-new-web")

apply the same logic for get_by_top() and get_by_latest().

Sources

================= ================== ============================ =================================================================== News API Param newsapi Param Value Description ================= ================== ============================ =================================================================== category category string (optional) The category you would like to get sources for. Possible options: business, entertainment, gaming, general, music, science-and-nature, sport, technology. Default: empty (all sources returned) language language string (optional) The 2-letter ISO-639-1 code of the language you would like to get sources for. Possible options: en, de, fr. Default: empty (all sources returned). country country string (optional) The 2-letter ISO 3166-1 code of the country you would like to get sources for. Possible options: au, de, gb, in, it, us. Default: empty (all sources returned). ================= ================== ============================ ===================================================================

Methods

All methods are accessible via:

.. code-block:: python

from newsapi.sources import Sources

s = Sources(API_KEY="Your-api-key")

s.<method>

====================================== ========================================================================================================== =============================================================================================================== ======================== Method Parameters Description Returns ====================================== ========================================================================================================== =============================================================================================================== ======================== get() category (optional), language (optional), country (optional), attributes_format (optional Default:True). Generic request to NewsApi to get sources as needed with optional params. (default : empty returns all sources AttrDict all() No parameters needed. wrapper around get() to get all sources unfiltered. AttrDict get_by_category() category (required). The category you would like to get sources for. AttrDict get_by_language() language (required). The 2-letter ISO-639-1 code of the language you would like to get sources for. AttrDict get_by_country() country (required). The 2-letter ISO 3166-1 code of the country you would like to get sources for. AttrDict information() No parameters needed. Sets up everything by sending an unfiltered request and then sorting it. Self all_sorted_information() No parameters needed. gives back all the sources. Array all_categories detailed (optional, Default: False, gives all the information of sources group by categories). Gets all the categories available by newsapi and grouped with info if detailed set to true. dict_keys/Dict all_languages detailed (optional, Default: False, gives all the information of sources group by languages). Gets all the languages available by newsapi and grouped with info if detailed set to true. dict_keys/Dict all_countries detailed (optional, Default: False, gives all the information of sources group by countries). Gets all the countries available by newsapi and grouped with info if detailed set to true. dict_keys/Dict all_base_information() No parameters needed. gives back all the name, id pairs of the available sources offered by newsapi. Dict all_ids() detailed (optional, Default: False, gives name, id pair of all the sources). gives back all the ids of the available sources offered by newsapi.