question

Upvotes
Accepted
carlos.feres3 avatar image
3 ●3 ●2 ●0

ESG API : maximum number of instruments, duplicated headers and process for adding new fields

Hi,

I have a few questions regarding the ESG API:


1) Maximum number of items in a request:

We were told that the ESG API can handle maximum 100 companies per request. However, trying the request with more than 100 ISINs we still get all the data in the response and no restriction in the response. Can you please confirm the maximum number of requests per item ( i.e. Get Measures Full) and how item restriction works?


Example:

https://api.refinitiv.com/data/environmental-social-governance/{ {RDP_VERSION_ESG}}/views/measures-full?universe=4295533401,4295613014,4295641240, 4295856018, 4295856019, 4295856020, 4295856021, 4295856025, 4295856026, 4295856029, 4295856031, 4295856039, 4295856043, 4295856044, 4295856050, 4295856051, 4295856053, 4295856055, 4295856058, 4295856060, 4295856061, 4295856067, 4295856070, 4295856073, 4295856074, 4295856077, 4295856080, 4295856082, 4295856083, 4295856084, 4295856086, 4295856087, 4295856094, 4295856097, 4295856098, 4295856099, 4295856108,4295856110, 4295856118, 4295856121, 4295856122, 4295856134, 4295856136, 4295856137, 4295856141, 4295856150, 4295856152, 4295856154, 4295856167, 4295856169, 4295856173, 4295856174, 4295856181, 4295856189, 4295856196, 4295856216, 4295856220, 4295856223, 4295856234, 4295856246, 4295856249, 4295856256, 4295856257, 4295856266, 4295856267, 4295856276, 4295856277, 4295856281, 4295856305, 4295856309, 4295856316, 4295856333, 4295856338, 4295856343, 4295856351, 4295856352, 4295856360, 4295856396, 4295856400, 4295856422, 4295856428, 4295856431, 4295856433, 4295856435, 4295856441, 4295856449, 4295856451, 4295856461, 4295856463, 4295856474, 4295856486, 4295856489, 4295856495, 4295856496, 4295856504, 4295856533, 4295856537, 4295856539,4295856542,4295856544,4295856551,4295856573,4295856578,4295856585 &format=noMessages&start=0&end=0



2) Duplication of "description" field in the Header session:

In the response of GetScores and GetMeasures calls, the fields in the "Header" have always a duplicated "Description" item? See below. Is this a bug? Are you planning to fix it anytime soon?

headers": [

{

"name": "instrument",

"title": "Instrument",

"type": "string",

"description": "The requested Instrument as defined by the user.",

"description": "The requested Instrument as defined by the user."

},

{

"name": "periodenddate",

"title": "Period End Date",

"type": "date",

"description": "The last day of the financial period in question.",

"description": "The last day of the financial period in question."

},

{

"name": "TR.TRESGCScore",

"title": "ESG Combined Score",

"type": "number",

"decimalChar": ".",

"description": "Thomson Reuters ESG Combined Score is an overall company score based on the reported information in the environmental, social and corporate governance pillars (ESG Score) with an ESG Controversies overlay.",

"description": "Thomson Reuters ESG Combined Score is an overall company score based on the reported information in the environmental, social and corporate governance pillars (ESG Score) with an ESG Controversies overlay."

},


Example requests:

https://api.refinitiv.com/data/environmental-social-governance/{ {RDP_VERSION_ESG}}/views/scores-standard?universe=NESN.S https://api.refinitiv.com/data/environmental-social-governance/

{ {RDP_VERSION_ESG}}/views/scores-full?universe=NESN.S&format=noMessages



3) How are new Measures added in the API?

In the last years Refinitiv has increased the number of measures covered by the below call. Can youplease clarify how new measures are added? <Are any new measures added as a Header at the bottom of previous existing Headers/measures? How are these new entries communicated to users of RDP?

https://api.refinitiv.com/data/environmental-social-governance/{ {RDP_VERSION_ESG}}/views/measures-full?universe=NESN.S&format=noMessages


Thanks,

Carlos

rdp-apirefinitiv-data-platformesg
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.

pimchaya.wongrukun01 avatar image   pimchaya.wongrukun01

Hello @carlos.feres3

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

If yes, please click the 'Accept' text next to the reply. This will guide all community members who have a similar question. Otherwise please post again offering further insight into your question.

Thanks,

AHS

chavalit-jintamalit avatar image   chavalit-jintamalit

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

4 Answers

· Write an Answer
Upvotes
Accepted
veerapath.rungruengrayubkul avatar image
11.3k ●25 ●9 ●14

Hi,

I'm able to see the duplicate description on the API DOCS using the Firefox Developer Tools. The API DOCS likely remove the duplicate description.


1595382631669.png (162.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.

Gurpreet avatar image Gurpreet

@veerapath.rungruengrayubkul, Can you please raise this issue with the product team. Thanks.

veerapath.rungruengrayubkul avatar image veerapath.rungruengrayubkul

@carlos.feres3

I will contact ESG product support and will update once I heard back from them.

Upvotes
Gurpreet avatar image
22.1k ●59 ●14 ●21

Hi @carlos.feres3,

#2: I don't see repeated description in the response message headers for any scores/measures endpoint. Can you please verify that it is not a bug in the code. You could also try python ESG sample provided in the downloads.


  "headers": [
    {
      "name": "instrument",
      "title": "Instrument",
      "type": "string",
      "description": "The requested Instrument as defined by the user."
    },
    {
      "name": "periodenddate",
      "title": "Period End Date",
      "type": "date",
      "description": "The last day of the financial period in question."
    },
    {
      "name": "TR.TRESGCScore",
      "title": "ESG Combined Score",
      "type": "number",
      "decimalChar": ".",
      "description": "Thomson Reuters ESG Combined Score is an overall company score based on the reported information in the environmental, social and corporate governance pillars (ESG Score) with an ESG Controversies overlay."
    },


For #1, and #3, please raise a ticket at Refinitiv Support to talk to a content/product expect. We can only answer technical questions on these forums.

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.

carlos.feres3 avatar image carlos.feres3

Hi Gurpreet,

we are not yet using the response in any code. This is simply what we get in Postman with a collection we imported from the Developpers Portal:


I disagree that points #1 and #3 are content questions. I am afraid if I raised these questions via your normal support, I will get replies related to the Eikon terminal ( as usual) while my concerning is specific to the calls in RDP platform.



1594043860282.png (159.6 KiB)
Gurpreet avatar image Gurpreet carlos.feres3

I still don't see duplicated description in the header. I have tried both Postman and the ApiDocs. Do you see the same result in the ApiDocs too?


1594045272218.png (92.5 KiB)
carlos.feres3 avatar image carlos.feres3 Gurpreet

Hi Gurpreet,

In the APIDocs I see only one item for "Description", however calling the API from Postman or our WebService we receive it always duplicated. Is this related maybe to our API account setup? Maybe the second description is supposed to be for another language, and as there’s none, it just repeats English as a fallback. Can you please check that?

Thanks,

Carlos

Gurpreet avatar image Gurpreet carlos.feres3

For #1 and #3, from Refinitiv support, select - Product Support -> I need help understanding content within the product, and select Elektron Data Platform - Environmental, Social & Governance as the product. This should help get to the right content group.

1594046352217.png (22.3 KiB)
Upvotes
Gurpreet avatar image
22.1k ●59 ●14 ●21
In the APIDocs I see only one item for "Description", however calling the API from Postman or our WebService we receive it always duplicated. Is this related maybe to our API account setup? Maybe the second description is supposed to be for another language, and as there’s none, it just repeats English as a fallback. Can you please check that?

Hi Carlos,

As far as I know, the description is provided in English only. The data is exactly same in the APIDocs as the webservice (it is invoking the REST API underneath). Could you try the latest version of Postman, or try the esgViews.py sample from the downloads tab - Python tutorials source code. Uncomment the line to view the raw JSON response message:

#print(json.dumps(vData, indent=2))
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.

carlos.feres3 avatar image carlos.feres3

We dont develop in Python. I have updated Postman to the latest version and I still see duplicated "Description" fields. We get the same when we call the API directly from our application. Can anyone check if the setup of our account is the reason for that? Thanks.

Carlos

Upvotes
Gurpreet avatar image
22.1k ●59 ●14 ●21

Hi @carlos.feres3,

We have not been able to replicate your issue -either with API or with Postman tool. Moreover, you also do not observe duplicate fields when using APIDocs. This leaves us with two possibilities - either your API version is incorrect, or it is a user error.

Can you confirm that your RDP_VERSION_ESG is v1.

You can use Fiddler proxy to capture the raw REST messages to confirm that there are indeed no duplicated fields. See the setup guide here.

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.