Json structure documentation

igorg
igorg Advocate
in Eikon Data APIs

Hello,

I can see on this forum that in multiply answers there is a reference to raw json request/response objects. Also python get_timeseries and get_data has 'raw_output' parameter that can be set to 1 and the data will come in json format.

We have some concerns about the usage of raw json data in production environment.

Is there any documentation about the format of json requests/responses for different type of data requests?

And the more important question, can we assume that the structure will not be silently changed without any notifications to the users?

Thanks

Tagged:

Best Answer

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

    The schema for JSON responses is purposely not publicly documented yet, as we do expect changes. The raw_output parameter was introduced primarily to aid troubleshooting, not to encourage the use of data in raw JSON format.
    This said Eikon Data APIs for Python library retrieves JSON from the Web service and returns pandas dataframe (by default). This fully supported library must interpret JSON documents returned by the Web service. Any breaking changes to the structure of the JSON returned by the Web service would require changes to the client side Python library, which means they cannot be introduced silently.
    We do expect that the structure of the JSON may change as we introduce new data distribution platform. It's very unlikely that this new platform will ever be used to feed existing version of Eikon (Eikon 4). It's very likely that this platform will only deliver data to the new version of Eikon known as Eikon 5, which is currently expected to see the first release mid next year.

Answers

Categories