- 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
Configuration file
For ease of use, you can set various initialization parameters of the session layer and whole RD Library in the refinitiv-data.config.json
configuration file - as detailed in the next section below.
Typically, you may place this file in the same folder as your Notebook or Python script. You can also place the file in your home folder, or you can place it in an alternative folder and specify the folder path using the RD_LIB_CONFIG_PATH environment variable.
Using configuration file
Using the Refinitiv data library config file allows you to specify various parameters such as:
- Default session
- Credentials
- Connectivity parameters
- Logging related:
- Enable/Disable console or file logging
- Log level
- Log file name
Using the refinitiv-data.config.json
file, where possible, provides the simplest approach to creating and opening sessions.
For example, assuming you have refinitiv-data.config.json
in the Configuration directory with the credentials and the specified default
session, you can create and open the default session as follows:
rd.open_session()
The above will look for an entry such as:
"sessions": {
"default": "desktop.workspace",
...
}
and then use the parameters defined in the config section ("desktop.workspace" in this example) to create and open a desktop session.
Note: If you do not have any configuration file, by default rd.open_session() creates and opens a desktop session. This session will try to connect to the Refinitiv Workspace (or Eikon) desktop application running on the same machine that your Python script.
Open a specific configured session
If you have multiple sessions configurations specified in the json file you can open a specific one by name e.g.:
rd.open_session(name='platform.rdp')
The above code would open a session based on the parameters specified in the "platform.rdp"
section of the json file.