- Introduction
- Concepts and Design
-
CONFIGURATION
-
SESSION LAYER
- About the Session Layer
-
Session
-
session.Definition
- session.Definition object
-
session.Definition object methods
-
session.desktop.Definition
- session.desktop.Definition object
-
session.desktop.Definition methods
-
session.platform.Definition
- session.platform.Definition object
-
session.platform.Definition methods
-
Functions
- Callback functions
- Session event codes
- Session states
-
ACCESS LAYER
-
CONTENT LAYER
- About the Content Layer
-
Fundamental and Reference
- About Fundamental And Reference
-
fundamental_and_reference.Definition
- fundamental_and_reference.Definition object
-
fundamental_and_reference.Definition methods
- fundamental_and_reference.RowHeaders
-
Historical Pricing
- About Historical Pricing
-
Historical Pricing Events
- About historical pricing events
-
historical_pricing.events.Definition
- historical_pricing.events.Definition object
-
historical_pricing.events.Definition methods
-
Historical Pricing Summaries
- About historical pricing summaries
-
historical_pricing.summaries.Definition
- historical_pricing.summaries.Definition object
-
historical_pricing.summaries.Definition methods
- Historical pricing event types
- Historical pricing adjustments
- Historical pricing market session
-
News
- About news
-
News headlines
- About news headlines
-
news.headlines.Definition
- news.headlines.Definition object
-
news.headlines.Definition methods
-
News stories
- About news stories
-
news.story.Definition
- news.story.Definition object
-
news.story.Definition methods
- News SortOrder
-
Pricing
- About pricing
-
pricing.Definition
- pricing.Definition object
-
pricing.Definition methods
-
pricing stream methods
-
pricing.chain
- About pricing.chain
-
pricing.chain.Definition
- pricing.chain.Definition object
-
pricing.chain methods
- Pricing stream states
-
Search
- About search
-
search.Definition
- search.Definition object
-
search.Definition methods
-
search.SearchViews
-
SymbolConversion
- About SymbolConversion
-
SymbolConversion.Definition
- SymbolConversion.Definition object
-
SymbolConversion.Definition methods
- Symbol types
- CountryCode
- AssetClass
- AssetState
-
Trade data service
- About trade data service
-
trade_data_service.Definition
- trade_data_service.Definition object
-
trade_data_service.Definition methods
-
trade_data_service Stream
- trade_data_service Stream object
-
trade_data_service Stream methods
- Trade data service events
- Trade data service universe types
- Trade data service finalized orders
-
Estimates
- About Estimates
-
Estimates actual values for reported annual periods
- estimates.view_actuals.annual.Definition object
-
estimates.view_actuals.annual.Definition methods
-
Estimates actual values for reported interim periods
- estimates.view_actuals.interim.Definition object
-
estimates.view_actuals.interim.Definition methods
-
Estimates actual values for KPI Measures for reported annual periods
- estimates.view_actuals_kpi.annual.Definition object
-
estimates.view_actuals_kpi.annual.Definition methods
-
Estimates actual values for KPI Measures for reported interim periods
- estimates.view_actuals_kpi.interim.Definition object
-
estimates.view_actuals_kpi.interim.Definition methods
-
Annual estimates summary data for periodic estimates measures
- estimates.view_summary.annual.Definition object
-
estimates.view_summary.annual.Definition methods
-
Interim estimates summary data for periodic estimates measures
- estimates.view_summary.interim.Definition object
-
estimates.view_summary.interim.Definition methods
-
Estimates monthly historical snapshot value for last 12 months for all annual period estimates measures
- estimates.view_summary.historical_snapshots_periodic_measures_annual.Definition object
-
estimates.view_summary.historical_snapshots_periodic_measures_annual.Definition methods
-
Estimates monthly historical snapshot value for last 12 months for all interim period estimates measures
- estimates.view_summary.historical_snapshots_periodic_measures_interim.Definition object
-
estimates.view_summary.historical_snapshots_periodic_measures_interim.Definition methods
-
Estimates monthly historical snapshot value for non-periodic estimates measures for the last 12 months
- estimates.view_summary.historical_snapshots_non_periodic_measures.Definition object
-
estimates.view_summary.historical_snapshots_non_periodic_measures.Definition methods
-
Estimates monthly historical snapshot value for recommendations for the last 12 months
- estimates.view_summary.historical_snapshots_recommendations.Definition object
-
estimates.view_summary.historical_snapshots_recommendations.Definition methods
-
Estimates summary values for KPI measures for annual periods
- estimates.view_summary_kpi.annual.Definition object
-
estimates.view_summary_kpi.annual.Definition methods
-
Estimates summary values for KPI measures for interim periods
- estimates.view_summary_kpi.interim.Definition object
-
estimates.view_summary_kpi.interim.Definition methods
-
Estimates monthly historical snapshot value for all KPI measures for the last 12 months
- estimates.view_summary_kpi.historical_snapshots_kpi.Definition object
-
estimates.view_summary_kpi.historical_snapshots_kpi.Definition methods
-
ESG
- About ESG
-
esg.full_measures.Definition
- esg.full_measures.Definition object
-
esg.full_measures.Definition methods
-
esg.full_scores.Definition
- esg.full_scores.Definition object
-
esg.full_scores.Definition methods
-
esg.basic_overview.Definition
- esg.basic_overview.Definition object
-
esg.basic_overview.Definition methods
-
esg.standard_measures.Definition
- esg.standard_measures.Definition object
-
esg.standard_measures.Definition methods
-
esg.standard_scores.Definition
- esg.standard_scores.Definition object
-
esg.standard_scores.Definition methods
-
esg.universe.Definition
- esg.universe.Definition object
-
esg.universe.Definition methods
-
esg.bulk.Definition
- esg.bulk.Definition object
-
esg.bulk.Definition methods
-
esg.bulk.PackageManager
- esg.bulk.PackageManager object
-
esg.bulk.PackageManager object methods
-
DELIVERY LAYER
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 semantics to keep the user session live. 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 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 Refinitiv Data Platform.
Depending on the access point your application uses to connect to Refinitiv Data Platform, you can create and open one of the following session types:
- DesktopSession. This type of session is used to connect to the Refinitiv Data Platform through Refinitiv Eikon or Refinitiv Workspace. It requires Refinitiv Eikon or Refinitiv Workspace to be running alongside your application. This type of session does not work with Refinitiv Eikon Web or Refinitiv Workspace for Web.
- PlatformSession. This type of session is used to connect directly to the Refinitiv Data Platform or through a Real-Time Distribution System. If you would like to connect directly to RDP, you require a Refinitiv Data account (either a user account or a machine account). In both instances, you need to provide Refinitiv 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, a DACS user name).
Platform session types require an app key that uniquely identifies your application. See tutorials of the Refinitiv Developer Community to learn how to create an app key for your application. With desktop session types, the app key is optional.