Introduction

This article will walk you throught steps to ensure that the Eikon Desktop is running properly on your machine.

It also guides you to check if the Eikon Data API(Python) is installed properly and up to date.

Also explain how to check Eikon Desktop log information to ensure that the service is running properly.

 

Prerequisites reading

Please read the quick start guide at https://developers.refinitiv.com/eikon-apis/eikon-data-api/quick-start before reading this article.

This article provides additional information to help troubleshooting when you cannot use Eikon Data APIs.

 

Troubleshooting Issues

If you encounter problem when trying to use Eikon Data APIs.

For example:

You may use the following information to identify and resolve API connection issues.

There are 4 sections in this article.

1. Check Eikon Desktop version

2. Check Eikon Data APIs version

3. Verify that Eikon Desktop and APIPROXY service is running properly

4. Execute sample code

 

1. Check Eikon Desktop version

Please follow these steps to check Eikon Desktop version on your machine.

1. Click on Eikon Menu button

2. Select "Help"

3. Select "About Thomson Reuters Eikon"

See below picture:

As of the time this article is published(Sep 2019), Eikon Desktop version is 4.0.50

2. Check Eikon Data APIs version

Please follow these steps to enable log on Eikon Desktop on your machine.

You can run this code to check the API version.

import eikon as ek
print(ek.__version__)

 

Here is the expected output. As of the time this article is published(Sep 2019), the API version is 1.0.1

You can use this command on a command line to upgrade Eikon Data APIs to the latest version

pip install --upgrade eikon

Here is the sample output:

You can use this command on a command line to confirm that Eikon Data APIs is installed on your machine.

pip search eikon

Here is the sample output:

 

3. Verify that Eikon Desktop is running properly and APIPROXY service is enabled

Please follow these steps to enable log on Eikon Desktop on your machine.

1. Launch Configuration Manager from Windows menu >> Thomson Reuters >> Configuration Manager

2. Enable the log on the Workstation, see picture below:

3. You can check the loation of the generated log file, click on "Open logs folder" to browse to the folder.

4. Browse into sub-folder TRD then to the most recent created folder with "Eikon.<datetime>.p<process-ID>" folder.

Then open the "SxS.<datetime>.p<process-id>.txt" file

5. Locate "APIPROXY" and "Listening to port" in the log file. By default, the port is 9000.

6. Open .portInUse file with text editor, the file is located at C:\Users\<WindowsUser>\AppData\Roaming\Thomson Reuters\Eikon API Proxy\

This is to re-confirm that API is connecting to the same port which Eikon Desktop is listening.

Note that if port 9000 is not available, Eikon Desktop will allocate the next available port e.g. 9001

 

7. Open http://localhost:9000/ping?all on a web browser. (Plese note that port 9000 is from step 5.)

And make sure that you can locate {"path":"/api"}.

This is a confirmation that the APIPROXY is running properly and ready for connect from Eikon Data APIs.

In the event that APIPROXY service is falled to start. A general guideline is to restart your machine and Eikon Desktop application.

If the problem still persists, contact Refinitiv Helpdesk at https://my.refinitiv.com/

 

4. Execute sample code

Once you have verified that API is installed successfully and Eikon Desktop with APIPROXY service is running properly on your machine.

You should be able to use the API.

Please try to run the following code:

import eikon as ek
ek.set_app_key('xxxxxxxxxxxxxxxxxxxxxxxxx') #A valid app key is required.
df,e = ek.get_data('REUTERS','TR.RIC')
print(df)

Here is  the expected output:

And this is the confirmation that your API is working properly !