Where to find documentation on JSON request and payload structure for the Eikon Data API?

Posting in behalf of client:

Where to find documentation on JSON request and payload structure for the Eikon Data API? As per client, details here (https://developers.refinitiv.com/en/api-catalog/eikon/eikon-data-api/documentation) only references the high level functions that return DataFrames and he is looking for a documentation with the JSON structure that the Eikon library is sending and receiving.

Best Answer

  • @Maria Antonette So we don't have separate documentation for the json_requests.send_json_request method. There is a doc string but its not that helpful. A good way to learn about using this is to monitor the traffic using a tool such as fiddler. Once fiddler is capturing IP traffic it can log the requests sent which are in JSON format. So you can specify say a get_data request and then check to see what the JSON payload looks like and then use the json_requests.send_json_request method to send the same or similar requests. To interrogate responses - you can use the get_data or get_timeseries or whatever method and then just set the parameter raw_output = True to receive a JSON response instead of a DataFrame.

    I hope this can help.