Getting started with PyPresseportal

Follow these steps to set up PyPresseportal and retrieve data from

1. Getting an API key

PyPresseportal requires a valid API key from You can request an API key on this website: This website is also where you can find general information on the API, as well as the API’s Terms.

2. Initializing the API

First, create an instance of the pypresseportal.PresseportalApi class, using your API key:

>>> from pypresseportal import PresseportalApi
>>> api_object = PresseportalApi(YOUR_API_KEY)

3. Requesting data from the API

Next, request data from the API through the PresseportalApi class. This class offers several methods to access API data. The Modules Documentation explains all available methods in detail.

The easiest way to access the most recently published stories is the get_stories() method. If you do not provide any arguments to this method, PyPresseportal defaults to retrieving the 50 most recent stories available.

For example:

>>> from pypresseportal import PresseportalApi
>>> api_object = PresseportalApi(YOUR_API_KEY)
>>> stories = api_object.get_stories()

4. Accessing the data

get_stories() returns a list of Story objects. Access Story data through the individual Story object’s attributes.

For example:

>>> stories[0].title
"Kohls Wohnhaus hat keinen Denkmalwert"
>>> stories[0].id

For each story the API returns, the method get_stories() will generate a Story object with the following attributes:

  • data - The raw json data returned by the API.

  • id - The story’s unique id as generated by the API.

  • url - URL of the story on the website.

  • title - Headline of the story.

  • body - Full text body.

  • optional: teaser - Teaser text. Only included if teaser=True is passed to get_stories(). If a teaser is requested, it will replace the body attribute.

  • published - Publication date (as datetime object).

  • language - Language of the story (usually ‘de’ or ‘en’).

  • ressort - Editorial department.

  • company_id - Unique id of the company publishing the story.

  • company_url - URL of the company publishing the story.

  • company_name - Name of the company publishing the story.

  • keywords - List of keywords assigned to the story.

  • optional: media - Information on media attachments, if present.

  • highlight - Promoted story flag (on/off).

  • short - Shortened URL.

5. Learning more about PyPresseportal

The API offers several ways to request data. See the Usage examples to see PyPresseportal in action. Detailed information about PyPresseportal is available in the Modules Documentation.

These are the methods supported by PyPresseportal: