Essential Guide to the Data Libraries

TL;DR

LSEG offers several data libraries to be used with LSEG Workspace/Refinitiv Eikon Desktop with different functionalities and statuses. As Eikon Data API is considered feature complete, we would like to encourage users to transition/use LSEG data library which is the latest version of our python library instead for the latest features and ongoing support. This guide also compares each library to help you make the right choice.

Note

• Eikon Data API Python library will be deprecated with Eikon. It's recommended to migrate to the new lseg-data library.
• Desktop access point (Desktop session) is connecting to the Data Platform via Data API Proxy that is available on both Eikon Desktop and LSEG Workspace. Hence, this access point connection via any python modules mentioned in this guide can be used with either Eikon Desktop or LSEG Workspace.
• We will ensure that there are no dependency conflicts between the Eikon library, the Refinitiv data library and the LSEG data library
• The data sources used by the Data Library's get_data() function will be fully aligned with those used by the Eikon Library's ek.get_data()
• Upgrade guide from Eikon to Workspace can be found in Upgrading to Workspace
  • Upgrade from using Eikon Data API to the Data library

Table of contents

1. FAQs - Frequency Asked Questions
2. The Data Libraries explaination and comparison table
3. What is the benefit of using the Data Library
4. Conclusion

FAQs - Frequency Asked Questions

This section contains FAQ of the Data Library. Please also read the detail of libraries in the next section, The Data Libraries.

1. Facing issues with the libraries?
   1. Check Eikon Data API and Refinitiv Data Library - Troubleshooting Guide for common issues
2. Which Library should be used?
   1. LSEG Data Library (LD Lib)
3. Any changes with the library and functions?
   1. There are improvement changes from EDAPI to RD Lib so functions and how to connect to the data platform is changed. In detail, please check Upgrade from using Eikon Data API to the Data library. Plus, newer functions with multiple abstraction layers (Access, Content, Delivery, Session Layer) are added into the RD Lib
   2. For RD Lib to LD Lib, currently there's no huge change (Except field parameter in get_data() of RD Lib is optional parameter - all available field will be returned in the result dataframe, but it's mandatory field in LD Lib)
4. Any changes with App Keys? (Will I need to get a new one for Workspace?)
   1. Any App Keys generated from App Key Generator can be used with EDAPI, RD Lib, LD Lib.

The Data Libraries

Several python libraries to be used with LSEG Workspace/Refinitiv Eikon Desktop are

1. Eikon Data API (Feature Complete)
2. Refinitiv Data Platform (Deprecated)
3. Refinitiv Data (Feature Complete)
4. LSEG Data (Active)

Here's the comparison table summarizing the key features, status, and details of each library.

What is the benefit of using the Data Library?

The Data Library is using likely similar Python code with Eikon Data API - with more options of session types to connect to the Data Platform

• Platform Session: connect to the Data Platform directly or via a local (deployed) Real-time Distribution System (RTDS).
  • connect directly - requires our data platform credentials (machine account)
  • or connect via local RTDS - requires connection details of your local platform (IP of the local server and DACS username).
• Desktop Session: connect to the Data Platform either via Eikon Desktop or via the LSEG Workspace application.
  • One of the Desktop application (Eikon/Workspace) must be running on the same machine as your Python code as it has Data API Proxy that will connect your local machine to the Data Platform via Data API Proxy to retrieve the data.
• Plus, library provides several abstraction layers
  • Access layer: The easiest way to get Refinitiv data.
  • Content layer: The basement of the Access layer.
  • Delivery layer: A low abstraction layer.
  • Session layer: defines interfaces allowing your application to connect to the Data Platform via different access points

Note: if you switch to an enterprise account, refinitiv-data and new lseg-data libs can be used with Platform access point

Conclusion

Choosing the right data library to use with LSEG Workspace Desktop application is crucial for efficient data access within the LSEG Data Platform, and while the Eikon Data API and Refinitiv Data Library have been a group of valuable tools, it's time to transition to the LSEG Data Library for its enhanced performance and ability.

To further explore the LSEG Data Library, visit its API page on the Developer Portal , or check the Developer Portal Q&A forum, or contact your account representative for assistance.