1. Home
  2. Article Catalog
  3. Eikon Data API(Python) Troubleshooting | Refinitiv

Article

Eikon Data API(Python) Troubleshooting | Refinitiv

Chavalit Jintamalit
Developer Advocate Developer Advocate

Introduction

This article will walk you through 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/en/api-catalog/eikon/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 a 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. Set log level on Eikon Data API

5. Execute sample code

 

1. Check Eikon Desktop version

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

1. Click on Eikon Menu button

2. Select "Help"

3. Select "About Refinitiv Eikon"

See below picture:

As of the time this article is published(March 2021), Eikon Desktop version is 4.0.53

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(March 2021), the API version is 1.1.8

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:

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 >> Refinitiv >> Configuration Manager

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

Please set "Trace Level" to "4 - Debug" only when you would like to troubleshoot the issue.

3. You can check the location 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 "API Proxy is available on port XXXX" in the log file. By default, the port is 9060.

6. Open http://localhost:9000/ping?all on a web browser.

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

7. Open http://localhost:9060/api/status on a web browser.

And make sure that you can locate "ST_PROXY_READY".

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

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

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

This log contains API call information which is very useful to investigate what happen to your API call.

4. Set Log Level on Eikon Data API

You can set log level on Eikon Data API to get additional information.

Please try to run the following code:

    	
            

import eikon as ek

ek.set_log_level(1) #This is to enable log detail

ek.set_app_key('xxxxxxxxxxxxxxxxxxxxxxxxx') #A valid app key is required.

This is the sample output of API successfully connect to Eikon Desktop(APIProxy)

This is the sample output of API unsuccessfully connect to Eikon Desktop(APIProxy)

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/ and ask the helpdesk to escalate the ticket to Technical Service Group.

Please also include APIProxy and SxS log files and Eikon Data API log.

 

5. 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 !