Article

How to discover available fields for Data Grid service on JET(App Studio HTML5 SDK) API using Eikon Desktop
Chavalit Jintamalit
Developer Advocate Developer Advocate

This article is intended for App Providers who develop and manage App Studio project on Eikon App Library.

Introduction

JET(App Studio HTML5 SDK) API provides a data client service module to get Data Grid content. It uses a simple request and response mechanism. The request contains a list of instruments and fields in JSON format. However, sometimes developer or business analyst may would like to explore what fields are available within Data Grid service.

 

Prerequisite

To follow steps in this article, you must have a basic understanding of HTML, JavaScript, JSON format and JET API.

To download and use JET API, please refer to the developer portal.

You must have Eikon Desktop application installed on your machine.

 

Data Grid Service Overview

The Data Grid service provides an API for accessing grids of data from the data cloud and real-time systems.  Data Grid is a data-item style of API (as opposed to a report/document style) in which the caller provides a list of information(fields) to retrieve and the instruments (companies) to retrieve it for.

 

Sample Data Grid Request using JET API

    	
            
{


    "instruments":["KKD.N","GOOGL.O","0005.HK"],


    "fields":[


        {"name":"TR.CommonName"},


        {"name":"TR.Revenue"}


    ]


}

The above JSON request message represents a request for "TR.CommonName" and "TR.Revenue" fields on "KKD.N", "GOOGL.O" and "0005.HK" instruments.

TR.CommonName description is "Where available provides the name of the organisation most commonly used."

TR.Revenue description is "Is used for industrial and utility companies. It consists of revenue from the sale of merchandise, manufactured goods and services, and the distribution of regulated energy resources, depending on a specific company's industry."

These 2 fields are the available fields from JET Data Grid call, however, this article will go in to detail on how to explore the available fields.

 

Sample Data Grid Response using JET API

    	
            
{


    "columnHeadersCount": 1,


    "data": [


             ["KKD.N", "Krispy Kreme Doughnuts Inc", 518714000],


             ["GOOGL.O", "Alphabet Inc", 90272000000],


             ["MSFT.O", "Microsoft Corp", 89950000000]


        ],


    "headerOrientation": "horizontal",


    "headers": [{


    "displayName": "Instrument"


    }, {


    "displayName": "Company Common Name",


    "field": "TR.COMMONNAME"


    }, {


    "displayName": "Revenue",


    "field": "TR.REVENUE"


        }


    ],


    "rowHeadersCount": 1,


    "totalColumnsCount": 3,


    "totalRowsCount": 4


}

The above JSON response message represents a response from Data Grid service with a given field and instrument.

 

Data Item Browser (DIB) Overview

DIB is an app built for the Eikon platform to allow users to quickly lookup Data Items and their definitions, preview and browse entire data offering for a given instrument.

User can use DIB to explore data items by search and configure supported parameters.

 

Flow to use DIB:

1. Launch DIB from:

  • App Library under "Data Item Browser App" name.

 

 

  • Type "DIB" on Eikon Search Bar

 

 

You should see this DIB screen.

 

 

2.    Input an instrument on the input textbox

 

 

You will see the instrument name on DIB title. Now you can start exploring the data items.

 

 

3. You may search for any field by typing in part of field name on the input textbox

 

 

4. You may also specific supported parameters on the Parameters tab.

 

 

5. Once you find the field and configure supported parameters, you can copy the formula from the button at the bottom right of DIB windows.

You can use this formula in the Data Grid request message which we covered earlier in our article.

 

 

From this example, this would be the field name:

    	
            
TR.TotalReturn1Mo(SDate=0M)

You can use this field to include it in your Data Grid request.

Here is the new Data Grid request:

    	
            
{


    "instruments":["KKD.N","GOOGL.O","0005.HK"],


    "fields":[


        {"name":"TR.CommonName"},


        {"name":"TR.Revenue"},


 {"name":"TR.TotalReturn1Mo(SDate=0M)"}


    ]


}

And this is the new response accordlingly:

    	
            
{


  "columnHeadersCount": 1,


  "data": [


    ["KKD.N", "Krispy Kreme Doughnuts Inc", 518714000, "NaN"],


    ["GOOGL.O", "Alphabet Inc", 90272000000, 3.1887498277927],


    ["0005.HK", "HSBC Holdings PLC", "", 0.3934426229508]


  ],


  "headerOrientation": "horizontal",


  "headers": [


    [


      {


        "displayName": "Instrument"


      },


      {


        "displayName": "Company Common Name",


        "field": "TR.COMMONNAME"


      },


      {


        "displayName": "Revenue",


        "field": "TR.REVENUE"


      },


      {


        "displayName": "1 Month Total Return",


        "field": "TR.TOTALRETURN1MO(SDATE=0M)"


      }


    ]


  ],


  "rowHeadersCount": 1,


  "totalColumnsCount": 4,


  "totalRowsCount": 4


}

Summary

Eikon Desktop provides "Data Item Browser" allowed developer to use this tool to explore all available content on a given ItemName.