Refinitiv Data Platform Library for TypeScript

About the Session Layer

This part of the documentation covers the session layer of the library.

Accessing the Refinitiv Data Platform to retrieve content requires your application to authenticate and manage connection. Refinitiv Data Libraries provide this managed access through an interface called a session. The session is the interface to the data platform and is responsible for defining authentication details, managing connection resources, and implementing the necessary protocol to communicate with the data platform.

Depending on the access point your application uses to connect to the platform, it can choose from one of the session implementations to initiate the connection. For the creation phase, all session implementations expose the same API and behave in the same way.
Once the session is created and opened, the application uses it in conjunction with objects of the Content or Delivery Layer to access the content and services available on the Refinitiv Data Platform.

Depending on the access point your application uses to connect to the Refinitiv Data Platform, it creates and opens one of the following sessions:

  • Desktop: This type of session is used to connect to the Refinitiv Data Platform either through Eikon or Workspace. It requires that Eikon or Workspace are running alongside your application. This type of session does not work with Eikon Web or Workspace for Web.

  • Container: This type of session is intended for applications integrated into a Refinitiv container (for example, Workspace or Workspace for Web) that need to connect to the Refinitiv Data Platform through this container.
    Note: This session type is only available with the Refinitiv Data Platform Library for TypeScript/JavaScript.

  • Platform: This type of session is used to connect directly to the Refinitiv Data Platform or through a local real-time enterprise platform. It requires a Refinitiv Data Platform account (either a user or a machine account) if you would like to connect directly to RDP, you need to provide Refinitiv Data Platform credentials to create the session. If you would like to work through a local platform, it requires the IP of the local platform and a user name (e.g. DACS user name).

All these session types require an App Key that uniquely identifies your application. To obtain an App Key for your application, refer to the Refinitiv Data Libraries.