Start using the Eikon Data API for Python in 4 steps

1. Run the Refinitiv Workspace application
2. Create an App Key for your application
3. Install the Python library for Eikon Data API
4. Let's have some fun!

1. Run the Refinitiv Workspace application

The Refinitiv Workspace desktop application integrates a Data API proxy that acts as an interface between the Eikon Data API Python library and the Refinitiv Workspace Platform. For this reason, the Refinitiv Workspace application must be running when using the Eikon Data API Python library. When launched, the Refinitiv Workspace application starts listening for local WebSocket connections on port 9000 or the next available port if port 9000 is already occupied. You need to have a valid user account to be able to launch the Refinitiv Workspace application.

2. Create an App Key for your application

Every application using the Eikon Data API must identify itself using an Application Key or App Key for short. The App Key, which is a unique identifier for your application, must be created using the App Key Generator app. Here is how to launch the app and create an App Key for a new application:

• In the Refinitiv Workspace toolbar type "App Key" and run the App Key Generator app:

• In the App Key Generator app indicate the name of your new application, the APIs it uses and click on the "Register New App" button:

• Read the "Terms & Conditions" and click on the "Accept" button

• Copy the App Key that you will use later in your new application:

3. Install the Python library for Eikon Data APIs

The Eikon Data API Python library is an ease-of-use library, which conveniently wraps the raw message transcription between Refinitiv Workspace and Python providing user-friendly data retrieval calls. The data output from the Python library for the Eikon Data API is available as Pandas DataFrames or as JSON objects.

Run the following command to install the Eikon Data API package from the Python Package Index (PyPI):

Note: This command must be run at the prompt of the command-line interpreter (CMD). If the "Script/" folder of your Python installation is not included in your PATH environment variable, you may even have to navigate to this folder before you run the pip command.

Below is an example of the expected output

4. Let's have some fun !

Launch Python IDE and try the following commands.

Initialize the Eikon object. Replace '8e5a3xxxxxxxxxxxxxxxxxxxxxxxxxxxx21b031c' with the App Key generated in step 2.

Note: In earlier versions of the Python library for Eikon Data APIs, the set_app_key function was called set_app_id. The set_app_id function is now deprecated but still works. If you use an earlier version of the Python library you can call set_app_id to set the App Key of your application.

Great, you have imported the library and set the App Key of your application. You are now ready to send data retrieval requests.

The following instruction retrieves news headlines on Deutsche Lufthansa AG (equity RIC: LHAG.DE), between 09:00 and 18:00 GMT on the 15th of Apr 2019.

out:

Now, let's display the latest news story satisfying the news search expression "EU AND POL", which represents news on the European Union politics.

First, retrieve the news headlines using the search expression, then get the story ID from the response and finally request the story.

The output is the HTML of the news story.

The following commands return time series of daily price history for Microsoft Corp ordinary share between 1st of Jan and 10th of Jan 2016.

out:

The following commands retrieve fundamental data - Revenue and Gross Profit - for Google, Microsoft abd Facebook

out:

You can specify additional parameters and request full year revenue and gross profit for the last two years scaled to millions and converted to Euros. E.g.

out:

You can also mix fundamental data with a snapshot of market data.

Out:

For further information visit the Tutorials section