- Introduction
- Concepts and Design
-
CONFIGURATION
-
SESSION LAYER
- About the Session Layer
-
Session
-
session.Definition
- Definition
-
Definition methods
-
session.desktop.Definition
- Definition
-
Definition methods
-
session.platform.Definition
- Definition
-
Definition methods
-
Functions
- Callback functions
- Session event codes
- Session states
-
ACCESS LAYER
- About the Access Layer
- Configuration
-
Dates and calendars
-
News
-
Functions
- open_session
- close_session
- get_data
- get_history
-
open_pricing_stream
- open_pricing_stream
- PricingStream
- PricingRecorder
-
PricingStream methods
-
PricingRecorder methods
-
CONTENT LAYER
- About the Content Layer
-
Fundamental and Reference
- About Fundamental And Reference
-
Definition
- Definition
-
Definition methods
- RowHeaders
-
Historical Pricing
- About Historical Pricing
-
Events
- About Events
- Definition
-
Definition methods
-
Summaries
- About Summaries
- Definition
-
Definition methods
- Historical pricing event types
- Historical pricing adjustments
- Historical pricing market session
-
News
- About news
-
News headlines
- About news headlines
- Definition
-
Definition methods
- Response
-
News stories
- About news stories
- Definition
-
Definition methods
- Response
-
Top news
- About top news
- Definition
-
Definition methods
- Response
-
hierarchy
- Definition
- TopNewsId
-
Definition methods
-
Online reports
- About online reports
- Definition
-
Definition methods
- Response
-
hierarchy
- Definition
-
Definition methods
-
Images
- About images
- Definition
-
Definition methods
- Response
- News SortOrder
-
Pricing
- About pricing
- Definition
-
Definition methods
-
pricing stream methods
-
pricing.chain
- About pricing.chain
- Definition
-
Definition methods
- Pricing stream states
-
IPA FinancialContracts
- About financial contracts
- Definition
-
Bond
- About bond
- Definition
-
Definition methods
-
Interfaces & Enumerations
- PricingParameters
- RoundingParameters
- BenchmarkYieldSelectionMode
- BusinessDayConvention
- DayCountBasis
- AdjustInterestToPaymentDate
- AmortizationFrequency
- AmortizationItem
- AmortizationType
- Direction
- Frequency
- IndexCompoundingMethod
- InterestType
- StubRule
- PaymentRollConvention
- PriceSide
- ProjectedIndexCalculationMethod
- RedemptionDateType
- Rounding
- RoundingType
- YieldType
- QuoteFallbackLogic
- CreditSpreadType
- DividendType
- VolatilityTermStructureType
- VolatilityType
-
Cap Floor
- About cap_floor
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
CDS
- About cds
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Fx Cross
- About FX Cross
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
IR Swap
- About Swap
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Option
- About option
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Repo
- About repo
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Swaption
- About swaption
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Term Deposit
- About term deposit
- termDeposit.Definition
-
Definition methods
-
Interfaces & Enumerations
- Response
-
IPA Curves
- About curves
-
Forward Curves
-
ZcCurves
-
IPA Surfaces
- About Surface
-
Cap
- About cap
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Eti
-
Fx
- About fx
- Definition
-
Interfaces & Enumerations
-
Swaption
- Definitions
-
Interfaces & Enumerations
- Response
-
Search
- About search
- Definition
-
Definition methods
-
SearchViews
-
SymbolConversion
- About SymbolConversion
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
Estimates
- About Estimates
-
Estimates actual values for reported annual periods
- Definition
-
Definition methods
-
Estimates actual values for reported interim periods
- Definition
-
Definition methods
-
Estimates actual values for KPI Measures for reported annual periods
- Definition
-
Definition methods
-
Estimates actual values for KPI Measures for reported interim periods
- Definition
-
Definition methods
-
Annual estimates summary data for periodic estimates measures
- Definition
-
Definition methods
-
Interim estimates summary data for periodic estimates measures
- Definition
-
Definition methods
-
Estimates monthly historical snapshot value for last 12 months for all annual period estimates measures
- Definition
-
Definition methods
-
Estimates monthly historical snapshot value for last 12 months for all interim period estimates measures
- Definition
-
Definition methods
-
Estimates monthly historical snapshot value for non-periodic estimates measures for the last 12 months
- Definition
-
Definition methods
-
Estimates monthly historical snapshot value for recommendations for the last 12 months
- Definition
-
Definition methods
-
Estimates summary values for KPI measures for annual periods
- Definition
-
Definition methods
-
Estimates summary values for KPI measures for interim periods
- Definition
-
Definition methods
-
Estimates monthly historical snapshot value for all KPI measures for the last 12 months
- Definition
-
Definition methods
-
ESG
- About ESG
-
Definition
- Definition
-
Definition methods
-
full_scores
- Definition
-
Definition methods
-
basic_overview
- Definition
-
Definition methods
-
standard_measures
- Definition
-
esg.standard_measures.Definition methods
-
standard_scores
- Definition
-
Definition methods
-
universe
- Definition
-
Definition methods
-
bulk
- Definition
-
Definition methods
-
PackageManager
- PackageManager
-
PackageManager methods
-
Custom Instruments
- About Custom Instruments
- Definition
-
Definition methods
-
Events
- Definition
-
Definition methods
-
Summaries
- Definition
-
Definition methods
-
Manage methods
- Response
-
DELIVERY LAYER
- About the Delivery Layer
-
Endpoint request
- About endpoint_request
- Definition
-
Definition methods
-
Interfaces & Enumerations
-
OMM stream
- About OMM stream
- Definition
-
Definition methods
-
RDP stream
- About RDP stream
- Definition
-
Definition methods
-
CFS
- About CFS
-
CFS buckets
- About CFS buckets
- Definition
-
Definition methods
-
CFS packages
- About CFS packages
- Definition
-
Definition methods
- Response
-
CFS files
- About CFS files
- Definition
-
Definition methods
- Response
-
CFS file-sets
- About CFS file_sets
- Definition
-
Definition methods
- Response
-
CFS file downloader
- About CFS file downloader
- Definition
-
Definition methods
About the Session Layer
This section 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 semantics to keep the user session live. LSEG Data Libraries provide this managed access through an interface called a session. The session is the interface to the Delivery Platform and is responsible for:
- Defining authentication details
- Managing connection resources
- Implementing the necessary protocol to communicate with the Delivery 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 can use it in conjunction with objects of the other layers (access layer, content layer, or delivery layer) to get access to the breadth and depth of content and services available on the Delivery Platform.
Depending on the access point your application uses to connect to the Delivery Platform, you can create and open one of the following session types:
- DesktopSession. This type of session is used to connect to the Delivery Platform through Eikon or LSEG Workspace. It requires Eikon or LSEG Workspace to be running alongside your application. This type of session does not work with Eikon Web or LSEG Workspace for Web.
- PlatformSession. This type of session is used to connect directly to the Delivery Platform or through a Real-Time Distribution System. If you would like to connect directly to the Delivery Platform, you require an LSEG Data account (either a user account or a machine account). In both instances, you need to provide LSEG Data credentials to create the session. If you would like to work through a Real-Time Distribution System, you need the IP of the local platform and a username - in other words, an LSEG Real-Time Data Access Control System (DACS) user name.
Platform session types require an app key that uniquely identifies your application. See tutorials of the LSEG Developer Community to learn how to create an app key for your application. With desktop session types, the app key is optional.