- Introduction
- Concepts and Design
-
SESSION LAYER
- About the Session Layer
-
Session
- Session object
-
Session object methods
-
Session.Platform
- Definition object
-
Definition methods
-
Session.Desktop
- Definition object
-
Definition methods
-
Session.Container
- Definition object
-
Definition methods
-
Functions
- Session events
- Session event codes
- Session states
-
CONTENT LAYER
- About the Content Layer
-
Fundamental and Reference
- About Fundamental and Reference
-
Definition
- Definition object
-
Definition methods
- RowHeaders
-
Historical Pricing
- About Historical Pricing
-
Events
- About Events
- Definition object
-
Definition methods
-
Summaries
- About Summaries
- Definition object
-
Definition methods
-
TimeSeries
- Definition object
-
Definition methods
-
Stream
- Stream object
-
Stream methods
- StreamEvents
-
Historical Pricing Metadata
- About Historical Pricing Metadata
-
Metadata Global
- Definition object
-
Definition methods
-
Metadata Instrument
- Definition object
-
Definition methods
-
Metadata Partialbar
- Definition object
-
Definition methods
-
Metadata Viewlist
- Definition object
-
Definition methods
- Event Types
- Adjustments
- Market Sessions
- Timestamp Labels
- Time Series Types
-
News
- About News
-
News Headlines
- Definition object
-
Definition methods
-
News Story
- Definition object
-
Definition methods
-
Pricing
- About Pricing
-
Pricing.Definition
- Definition object
-
Definition methods
-
Pricing.Stream
-
Pricing.Chain
- About Pricing.Chain
-
Pricing.Chain.Definition
- Definition object
-
Definition methods
-
Pricing.Chain.Stream
- Stream object
-
Stream methods
- Pricing.Chain.Events
-
Search
- About Search
-
Search.Definition
- Definition object
-
Definition methods
- Search View
-
SymbolConversion
- About SymbolConversion
-
Definition
- Definition object
-
Definition methods
- Asset Class
- Asset State
- Country Code
-
IPA
-
FinancialContracts
- About FinancialContracts
-
Definition
- Definition object
-
Definition methods
-
Bond
- Bond.Definition object
-
Bond.Definition methods
-
Interfaces & Enumerations
- PricingParameters
- CreditSpreadType
- InflationMode
- QuotationMode
- QuoteFallbackLogic
- VolatilityTermStructureType
- VolatilityType
- ProjectedIndexCalculationMethod
- RedemptionDateType
- BenchmarkYieldSelectionMode
- Rounding
- AmortizationFrequency
- AmortizationItemDefinition
- AmortizationType
- IndexAverageMethod
- IndexCompoundingMethod
- IndexObservationMethod
- RoundingType
- YieldType
-
BondFuture
- BondFuture.Definition object
-
BondFuture.Definition methods
- BondFuture.UnderlyingContract
-
CapFloor
- CapFloor.Definition object
-
CapFloor.Definition methods
-
Interfaces & Enumerations
-
CDS
- CDS.Definition object
-
CDS.Definition methods
-
Interfaces & Enumerations
-
FxCross
- FxCross.Definition object
-
FxCross.Definition methods
-
Interfaces & Enumerations
-
IRSwap
- IRSwap.Definition object
-
IRSwap.Definition methods
-
Interfaces & Enumerations
-
Option
- Option.Definition object
-
Option.Definition methods
-
Interfaces & Enumerations
-
Repo
- Repo.Definition object
-
Repo.Definition methods
-
Interfaces & Enumerations
-
Swaption
- Swaption.Definition object
-
Swaption.Definition methods
-
Interfaces & Enumerations
-
TermDeposit
- TermDeposit.Definition object
-
TermDeposit.Definition methods
-
Interfaces & Enumerations
-
Curves
- About Curves
-
ForwardCurve
- ForwardCurve.Definition object
-
ForwardCurve.Definition methods
-
Interfaces & Enumerations
-
ForwardCurves
- ForwardCurves.Definition object
-
ForwardCurves.Definition methods
-
ZcCurve
- ZcCurve.Definition object
-
ZcCurve.Definition methods
-
Interfaces & Enumerations
-
ZcCurves
- ZcCurves.Definition object
-
ZcCurves.Definition methods
-
ZcCurveDefinition
- ZcCurveDefinition.Definition object
-
ZcCurveDefinition.Definition methods
-
ZcCurveDefinitions
- ZcCurveDefinitions.Definition object
-
ZcCurveDefinitions.Definition methods
-
Interfaces & Enumerations
-
Surfaces
- About Surfaces
-
Surfaces.Definition
- Surfaces.Definition object
-
Surfaces.Definition methods
-
Cap
- Cap.Definition object
-
Cap.Definition methods
- CalculationParams
-
Eti
- Eti.Definition object
-
Eti.Definition methods
- CalculationParams
-
Fx
- Fx.Definition object
-
Fx.Definition methods
- CalculationParams
-
Swaption
- Swaption.Definition object
-
Swaption.Definition methods
- CalculationParams
-
Interfaces & Enumerations
-
DatesAndCalendars
- About Dates And Calendars
-
AddPeriods
- AddPeriods.Definition object
-
AddPeriods.Definition methods
-
AddPeriods.Definitions
- Definitions object
-
Definitions methods
-
CountPeriods
- CountPeriods.Definition object
-
CountPeriods.Definition methods
-
CountPeriods.Definitions
- Definitions object
-
Definitions methods
-
DateSchedule
- About DateSchedule
-
DateSchedule.Definition
- Definition object
-
Definition methods
-
Holidays
- Holidays.Definition object
-
Holidays.Definition methods
-
Holidays.Definitions
- Definitions object
-
Definitions methods
-
IsWorkingDay
- IsWorkingDay.Definition object
-
IsWorkingDay.Definition methods
-
IsWorkingDay.Definitions
- Definitions object
-
Definitions methods
-
Interfaces & Enumerations
-
- Content Response
-
DELIVERY LAYER
- About the Delivery Layer
-
Endpoint Request
- About EndpointRequest
-
EndpointRequest.Definition
- Definition object
-
Definition methods
-
OMM streams
- About OMM streams
-
OMMStream.Definition
- Definition object
-
Definition methods
-
OMMStream
- OmmStream object
-
OMMStream methods
- OMMStream events
- OMMStream states
-
RDP streams
- About RDP streams
-
RDPStream.Definition
- Definition object
-
Definition methods
-
RDPStream
- RDPStream object
-
RDPStream methods
- RDPStream events
- RDPStream response state
- RDPStream states
About the Session Layer
This part of the documentation covers the session layer of the library.
Accessing the Delivery Platform (formerly Refinitiv Data Platform) to retrieve content requires your application to authenticate and manage connection. LSEG 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 Delivery Platform.
Depending on the access point your application uses to connect to the Delivery Platform, it creates and opens one of the following sessions:
-
Desktop: This type of session is used to connect to the Delivery 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 LSEG container (for example, Workspace or Workspace for Web) that need to connect to the Delivery Platform through this container.
Note: This session type is only available with the LSEG Data Library for TypeScript/JavaScript. -
Platform: This type of session is used to connect directly to the Delivery Platform or through a local real-time enterprise platform. It requires a Delivery Platform account (either a user or a machine account) if you would like to connect directly to RDP, you need to provide Delivery 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 LSEG Data Libraries.