Metadata-Version: 1.0
Name: eikon
Version: 1.0.2
Summary: Python package for retrieving Eikon data.
Home-page: https://developers.refinitiv.com/eikon-apis/eikon-data-api
Author: REFINITIV
Author-email: UNKNOWN
License: LICENSE
Description: The Eikon Data API for Python allows your Python applications to access

        data directly from Eikon or Refinitv Workspace, powering in-house or

        thirdparty desktop apps with Refinitiv data. It provides seamless

        workflow with the same data across all applications running on the

        desktop. It leverages Eikon data and entitlements to simplify market

        data management and reporting. The Eikon Data API for Python is a

        software library that works in conjunction with the

        `Eikon <http://solutions.refinitiv.com/eikon-trading-software>`__

        desktop application and `Refinitiv

        Workspace <https://www.refinitiv.com/en/products/refinitiv-workspace-wealth>`__.

        

        Some examples

        =============

        

        Import Eikon and set your App Key

        ---------------------------------

        

        .. code:: python

        

           import eikon as ek

        

           ek.set_app_key('8e9bxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx1b035d')

        

        Get Real-time Snapshots

        -----------------------

        

        .. code:: python

        

           df, err = ek.get_data(

               instruments = ['GOOG.O','MSFT.O', 'FB.O'], 

               fields = ['BID','ASK']

           )

           display(df)

        

        +---+------------+---------+---------+

        |   | Instrument | BID     | ASK     |

        +===+============+=========+=========+

        | 0 | GOOG.O     | 1350.48 | 1352.19 |

        +---+------------+---------+---------+

        | 1 | MSFT.O     | 152.38  | 152.40  |

        +---+------------+---------+---------+

        | 2 | FB.O       | 203.08  | 203.15  |

        +---+------------+---------+---------+

        

        Get Fundamental & Reference data

        --------------------------------

        

        .. code:: python

        

           df, err = ek.get_data(

               instruments = ['GOOG.O','MSFT.O', 'FB.O'], 

               fields = ['TR.LegalAddressCity','TR.LegalAddressLine1','TR.Employees']

           )

           display(df)

        

        +-------------+-------------+-------------+-------------+-------------+

        |             | Instrument  | Legal       | Legal       | Full-Time   |

        |             |             | Address     | Address     | Employees   |

        |             |             | City        | Line 1      |             |

        +=============+=============+=============+=============+=============+

        | 0           | GOOG.O      | WILMINGTON  | 251 Little  | 98771       |

        |             |             |             | Falls Dr    |             |

        +-------------+-------------+-------------+-------------+-------------+

        | 1           | MSFT.O      | TUMWATER    | 300         | 144000      |

        |             |             |             | Deschutes   |             |

        |             |             |             | Way SW Ste  |             |

        |             |             |             | 304         |             |

        +-------------+-------------+-------------+-------------+-------------+

        | 2           | FB.O        | WILMINGTON  | 251 Little  | 35587       |

        |             |             |             | Falls Dr    |             |

        +-------------+-------------+-------------+-------------+-------------+

        

        Get TimeSeries

        --------------

        

        .. code:: python

        

           ek.get_timeseries('AAPL.O', interval='minute')

        

        +---------------------+----------+----------+----------+----------+--------+----------+

        | AAPL.O              | HIGH     | LOW      | OPEN     | CLOSE    | COUNT  | VOLUME   |

        +=====================+==========+==========+==========+==========+========+==========+

        | **Date**            |          |          |          |          |        |          |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | 2019-09-12 19:57:00 | 223.2000 | 222.8600 | 223.1800 | 222.9600 | 3387.0 | 267258.0 |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | 2019-09-12 19:58:00 | 223.1800 | 222.8900 | 222.9700 | 223.1700 | 1925.0 | 210251.0 |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | 2019-09-12 19:59:00 | 223.2800 | 223.0800 | 223.1700 | 223.1500 | 2106.0 | 223191.0 |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | …                   | …        | …        | …        | …        | …      | …        |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | 2019-12-12 14:31:00 | 268.3000 | 267.3200 | 267.8200 | 267.9350 | 2974.0 | 724278.0 |

        +---------------------+----------+----------+----------+----------+--------+----------+

        | 2019-12-12 14:32:00 | 268.3600 | 267.6000 | 267.9500 | 268.3000 | 1721.0 | 193413.0 |

        +---------------------+----------+----------+----------+----------+--------+----------+

        

        50000 rows by 6 columns

        

        Get News HeadLines

        ------------------

        

        .. code:: python

        

           ek.get_news_headlines('IBM.N', count=100)

        

        +---+---------------------------+-------+-------------+-------------------+

        |   | versionCreated            | text  | storyId     | sourceCode        |

        +===+===========================+=======+=============+===================+

        | 2 | 2019-12-12 12:45:10.958   | IBM   | urn:newsml: | NS:ASNEWS         |

        | 0 |                           | India | reuters.com |                   |

        | 1 |                           | calls | :20191212:n |                   |

        | 9 |                           | for   | NRAafsi86:1 |                   |

        | - |                           | balan |             |                   |

        | 1 |                           | ce    |             |                   |

        | 2 |                           | betwe |             |                   |

        | - |                           | en    |             |                   |

        | 1 |                           | prote |             |                   |

        | 2 |                           | cting |             |                   |

        | 1 |                           | …     |             |                   |

        | 2 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 4 |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 1 |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | . |                           |       |             |                   |

        | 9 |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 8 |                           |       |             |                   |

        +---+---------------------------+-------+-------------+-------------------+

        | 2 | 2019-12-12 12:03:54.056   | Red   | urn:newsml: | NS:DATMTR         |

        | 0 |                           | Hat   | reuters.com |                   |

        | 1 |                           | annou | :20191212:n |                   |

        | 9 |                           | nces  | NRAafs2g9:1 |                   |

        | - |                           | renew |             |                   |

        | 1 |                           | al    |             |                   |

        | 2 |                           | of    |             |                   |

        | - |                           | FIPS  |             |                   |

        | 1 |                           | 140-2 |             |                   |

        | 2 |                           | secur |             |                   |

        | 1 |                           | i…    |             |                   |

        | 2 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | 3 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 4 |                           |       |             |                   |

        | . |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 6 |                           |       |             |                   |

        +---+---------------------------+-------+-------------+-------------------+

        | 2 | 2019-12-12 08:07:44.753   | Engin | urn:newsml: | NS:GLOBML         |

        | 0 |                           | eer   | reuters.com |                   |

        | 1 |                           | forev | :20191212:n |                   |

        | 9 |                           | er    | NRAafpj8v:1 |                   |

        | - |                           | chang |             |                   |

        | 1 |                           | ed    |             |                   |

        | 2 |                           | retai |             |                   |

        | - |                           | l     |             |                   |

        | 1 |                           | with  |             |                   |

        | 2 |                           | creat |             |                   |

        | 0 |                           | ion   |             |                   |

        | 8 |                           | …     |             |                   |

        | : |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | 7 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 4 |                           |       |             |                   |

        | 4 |                           |       |             |                   |

        | . |                           |       |             |                   |

        | 7 |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 3 |                           |       |             |                   |

        +---+---------------------------+-------+-------------+-------------------+

        | … | …                         | …     | …           | …                 |

        +---+---------------------------+-------+-------------+-------------------+

        | 2 | 2019-12-03 16:18:50.532   | Unite | urn:newsml: | NS:ECLPCM         |

        | 0 |                           | d     | reuters.com |                   |

        | 1 |                           | State | :20191203:n |                   |

        | 9 |                           | s     | NRAad1a5r:1 |                   |

        | - |                           | : IBM |             |                   |

        | 1 |                           | Watso |             |                   |

        | 2 |                           | n     |             |                   |

        | - |                           | Healt |             |                   |

        | 0 |                           | h     |             |                   |

        | 3 |                           | Demon |             |                   |

        | 1 |                           | strat |             |                   |

        | 6 |                           | es…   |             |                   |

        | : |                           |       |             |                   |

        | 1 |                           |       |             |                   |

        | 8 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | . |                           |       |             |                   |

        | 5 |                           |       |             |                   |

        | 3 |                           |       |             |                   |

        | 2 |                           |       |             |                   |

        +---+---------------------------+-------+-------------+-------------------+

        | 2 | 2019-12-03 13:00:10.642   | Nozom | urn:newsml: | NS:GNW            |

        | 0 |                           | i     | reuters.com |                   |

        | 1 |                           | Netwo | :20191203:n |                   |

        | 9 |                           | rks   | GNX8Yr8Hy:1 |                   |

        | - |                           | Works |             |                   |

        | 1 |                           | with  |             |                   |

        | 2 |                           | IBM   |             |                   |

        | - |                           | to    |             |                   |

        | 0 |                           | Secur |             |                   |

        | 3 |                           | e     |             |                   |

        | 1 |                           | Indus |             |                   |

        | 3 |                           | …     |             |                   |

        | : |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | : |                           |       |             |                   |

        | 1 |                           |       |             |                   |

        | 0 |                           |       |             |                   |

        | . |                           |       |             |                   |

        | 6 |                           |       |             |                   |

        | 4 |                           |       |             |                   |

        | 2 |                           |       |             |                   |

        +---+---------------------------+-------+-------------+-------------------+

        

        100 rows by 4 columns

        

        Get Symbology

        -------------

        

        .. code:: python

        

           ek.get_symbology(['MSFT.O', 'GOOG.O', 'IBM.N'])

        

        +--------+-----------+--------------+------------+--------+---------+--------+

        |        | CUSIP     | ISIN         | OAPermID   | RIC    | SEDOL   | ticker |

        +========+===========+==============+============+========+=========+========+

        | MSFT.O | 594918104 | US5949181045 | 4295907168 | MSFT.O | NaN     | MSFT   |

        +--------+-----------+--------------+------------+--------+---------+--------+

        | GOOG.O | 02079K107 | US02079K1079 | 5030853586 | GOOG.O | NaN     | GOOG   |

        +--------+-----------+--------------+------------+--------+---------+--------+

        | IBM.N  | 459200101 | US4592001014 | 4295904307 | IBM.N  | 2005973 | IBM    |

        +--------+-----------+--------------+------------+--------+---------+--------+

        

        Learning materals

        =================

        

        To learn more about the Eikon Data API Python library just connect to

        the Refinitiv Developer Community. By

        `registering <https://developers.refinitiv.com/iam/register>`__ and

        `login <https://developers.refinitiv.com/iam/login>`__ to the Refinitiv

        Developer Community portal you will get free access to a number of

        learning materials like `Quick Start

        guides <https://developers.refinitiv.com/eikon-apis/eikon-data-api/quick-start>`__,

        `Tutorials <https://developers.refinitiv.com/eikon-apis/eikon-data-api/learning>`__,

        `Documentation <https://developers.refinitiv.com/eikon-apis/eikon-data-api/docs>`__

        and much more.

        

        Help and Support

        ================

        

        If you have any questions regarding the API usage, please post them on

        the `Eikon Data API Q&A

        Forum <https://community.developers.thomsonreuters.com/spaces/92/index.html>`__.

        The Refinitiv Developer Community will be very pleased to help you.

        
Platform: UNKNOWN
