Upgrade from Eikon -> Workspace. Learn about programming differences.

For a deeper look into our Eikon Data API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials |  Articles

question

Upvote
Accepted
Vinit avatar image
16 ●0 ●1 ●3

"ESG Disclosure" download: S&P 500

Hello. Thank You for creating this amazing community and I hope to learn and contribute.

I am working on a project where I need the following for S&P 500.

  • ESG disclosures (.pdf)
  • ESG data

I have been able to easily get all my relevant data for ESG requesting Eikon Data API via Jupyter.

##CODE here for future reference

# Imports and setting up Eikon app key to be able to use Eikon Data API.
import eikon as ek
import pandas as pd

#ek.set_app_key(EIKON_APP_KEY) call using app key generated in Refinitiv
ek.set_app_key('xxxxxxxxxxxxxxxxxxxx')

#data for S&P 500
df, err = ek.get_data(['0#.SPX'], ['TR.CommonName','TR.TRBCBusinessSector','TR.TRESGScore.Date','TR.CompanyMarketCap(Curn=USD,ShType=OUT)','TR.TRESGScore','TR.TRESGScoreGrade','TR.ESGCScore',"TR.TRESGCScoreGrade",'TR.EnvironmentPillarScore','TR.SocialPillarScore','TR.fdfdf','TR.TRESGResourceUseScore'],
{'Scale': 6, 'SDate': 0, 'EDate': -10, 'FRQ': 'FY', 'Curn': 'USD'})

pd.options.display.float_format = '{:,.2f}'.format 

df

However, I am finding it difficult to download the correct ESG reports as "ESG disclosure".

It is unfortunately not clear, which reports are to be downloaded as the form names and subsequently the content vary a lot across companies (Company search-> Filing-> Filtering on Categories as ESG disclosures) (Example of Apple and Alphabet included).

Is there a method where I can bulk download the correct reports (form names) using API? If not, is it possible to advise on the correct ESG disclosures (as form names)

Thanks a lot for guidance.

Apple ESG.png

Alphabet ESG.png

apiesgbulk-downloaddownload-file
apple-esg.png (229.6 KiB)
alphabet-esg.png (228.2 KiB)
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

wasin.w avatar image   wasin.w

Hello @Vinit

Thank you for your participation in the forum. Is the reply below satisfactory in resolving your query?


If so please can you click the 'Accept' text next to the appropriate reply? This will guide all community members who have a similar question.

Thanks,


AHS

Jirapongse avatar image   Jirapongse

@Vinit

Hi,

Please be informed that a reply has been verified as correct in answering the question, and marked as such.

Thanks,

AHS

1 Answer

· Write an Answer
Upvotes
Accepted
wasin.w avatar image
24.7k ●54 ●17 ●14

Hello @Vinit

The Eikon Data API does not provide bulk file download interfaces for developers. You may need to use the Refinitiv Data Platform (RDP) APIs instead. The RDP APIs are the set of web-based API that provides Refinitiv data/content via various delivery mechanisms such as Request-Response, Bulks file, Alert, etc.

The RDP APIs let developers get the ESG Bulk file dynamically via the /file-store/ API endpoint. You can find more detail about the service on the RDP APIs - Documentation ESG Bulk Schemas page.

esg-bulk.png

There is a Postman example that may help you too. You can download the Postman collection here and check how to set up it here.

postman.png

Caution:

Please note that the RDP APIs need a separate account credential from the Eikon Data API. Please contact your Refinitiv representative about the RDP APIs account access.

Hope this helps.



esg-bulk.png (71.1 KiB)
postman.png (83.2 KiB)
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.