Where to find documentation on Equity Screener API in python for Eikon?

gabriel_ling
gabriel_ling Newcomer
in Eikon Data APIs

Hi, I wish to find documentation on the API function get_data('SCREEN..) used in the following code:

ek.get_data('SCREEN(U(IN(Equity(active,public,primary))/*UNV:Public*/), IN(TR.ExchangeMarketIdCode,"XASX"))','TR.CommonName')

I have looked in the 'Eikon Data APIs for Python - Reference Guide'. It has an entry for get_data, but nothing on SCREEN.

Thanks,

Gabriel

Tagged:

Best Answer

  • Alex Putkov.1
    Alex Putkov.1 ✭✭✭✭✭
    Answer ✓

    There's no public documentation defining the syntax of screener expressions. You're expected to use the Screener app GUI to set the criteria, then insert the formula into Excel. Then you can copy & paste screener expression from Excel formula into your Python script.
    For more info on using the Screener app see video tutorial titled "Create Data Retrieval Functions using Equity Screener in Excel" available under Eikon main menu - Help - Tutorials and Training.

Categories