LSEG Data Library for Python - extended documentation for valid parameter values

Where can i get full documentation of all the valid arguments that can be used with the LSEG Data library for python?
For example, the get Fundamentals data function takes a dict for the parameters argument - where can i get a list of all the keys and definitions that are supported for this arg?
https://cdn.refinitiv.com/public/lseg-lib-python-doc/2.0.0.2/book/en/sections/content-layer/fundamental-reference/fundamental-and-reference-definition.html
Thanks!
Answers
-
The parameters dictionary is basically a name:value pair defined using a standard Python dict:
parameters = {'SData': '0CY', 'Curn': 'CAD'}
Because the possible values and combinations is so extensive and does change from time to time, the proper way to determine the available parameters is to utilize the Data Item Browser (DIB) within Workspace. For example:
In the above, when you click on a field of interest (left side), you will be presented with a description and possible parameters to use - it is here where you would determine your name/value pairs. For example, there are 4 different name value/pairs for the TR.Volume field selected:
fields = TR.Volume(SDate=0,EDate=-1,Frq=D,Scale=5)
However, the parameters dict will apply to all fields within your request like this:
fields = ["TR.Volume"], parameters = { 'SDate': 0, 'EDate': -1, 'Frq': 'D', 'Scale': 5 }
Refer to the 'GetData()' function - which you can use instead - for some examples.
1 -
Hi @jonathan.yow
I would also look for some videos/articles within the developer portal.0
Categories
- All Categories
- 3 Polls
- 6 AHS
- 36 Alpha
- 166 App Studio
- 6 Block Chain
- 4 Bot Platform
- 18 Connected Risk APIs
- 47 Data Fusion
- 34 Data Model Discovery
- 685 Datastream
- 1.4K DSS
- 615 Eikon COM
- 5.2K Eikon Data APIs
- 10 Electronic Trading
- Generic FIX
- 7 Local Bank Node API
- 3 Trading API
- 2.9K Elektron
- 1.4K EMA
- 252 ETA
- 556 WebSocket API
- 38 FX Venues
- 14 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 23 Messenger Bot
- 3 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 60 Open Calais
- 275 Open PermID
- 44 Entity Search
- 2 Org ID
- 1 PAM
- PAM - Logging
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 22 RDMS
- 1.9K Refinitiv Data Platform
- 652 Refinitiv Data Platform Libraries
- 4 LSEG Due Diligence
- LSEG Due Diligence Portal API
- 4 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.2K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 12 World-Check Customer Risk Screener
- 1K World-Check One
- 46 World-Check One Zero Footprint
- 45 Side by Side Integration API
- 2 Test Space
- 3 Thomson One Smart
- 10 TR Knowledge Graph
- 151 Transactions
- 143 REDI API
- 1.8K TREP APIs
- 4 CAT
- 27 DACS Station
- 121 Open DACS
- 1.1K RFA
- 104 UPA
- 193 TREP Infrastructure
- 228 TRKD
- 917 TRTH
- 5 Velocity Analytics
- 9 Wealth Management Web Services
- 90 Workspace SDK
- 11 Element Framework
- 5 Grid
- 18 World-Check Data File
- 1 Yield Book Analytics
- 46 中文论坛