Swagger documentation for the Eikon API

MarkJoseph.Canada

is there a Swagger documentation for the Eikon API? I checked for related questions but it appears we don't have one for Eikon. Kindly advise. Thanks.

Gurpreet

Hello @MarkJoseph.Canada,

There is no swagger documentation for the EDAPI. This API is not restful and mainly contains 4 data API calls with a lot of parameters.

Best means to retrieve the data programmatically from the Eikon/Workspace is through the use of LSEG data libraries. These are convenient to use and are bundled with a lot of examples. Ensure that you use the desktop session for a connection to Eikon/WS.

raksina.samasiri

Hi @MarkJoseph.Canada ,

Here's more resources related to LSEG Data library

(Some articles here is still using the refinitiv.data library, it’ll be updated to lseg.data library soon. However, the functions of them are kind of similar so you could just change the library that you’re importing and it will works with the LSEG data library one.

1. In case you have questions regarding API usage, feel free to check or make a new post at our developer portal Q&A Forum https://community.developers.refinitiv.com/index.html
2. The Data Library for Python – API page in the developer portal (including overview, quickstart, documentation, tutorials): https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python
   1. Useful article - The Data Library for Python - Quick Reference Guide (Access layer): https://developers.lseg.com/en/article-catalog/article/the-data-library-for-python-quick-reference-guide-access-layer
3. Example code https://github.com/LSEG-API-Samples/Example.DataLibrary.Python/tree/lseg-data-examples
   1. get_data and how to apply parameters (such as currency) https://github.com/LSEG-API-Samples/Example.DataLibrary.Python/blob/lseg-data-examples/Examples/1-Access/EX-1.01.01-GetData.ipynb
4. Related articles can be found in https://developers.lseg.com/en/article-catalog
   1. Find content and functionality using the Data Library with Workspace Advanced Search: https://developers.lseg.com/en/article-catalog/article/Find-content-and-functionality-using-Refinitiv-Data-Library-with-Eikon-Advanced-Search
   2. Find Your Right Companies with SCREENER | the Data Library (Python): https://developers.lseg.com/en/article-catalog/article/find-your-right-companies-with-screener-eikon-data-apis-python
5. Usage and Limits Guideline - https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python/documentation#reference-guide
6. Desktop session - Using local environment instead of Codebook: https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python/quick-start#getting-started-with-python