List of available parameters for IPA API in Python
Hi there, I was wondering if there was a list of available input parameters for IPA API in Python, similar to these:
calculation_params = bond.CalculationParams(
market_data_date="2020-07-05",
price_side = ipa.enum_types.PriceSide.BID,
most of the time, I can add underscore between words to make it work, but for parameters such as 'reportCcy', it won't work in Python.
reportCcyStringThe reporting currency code, expressed in ISO 4217 alphabetical format (e.g., 'USD'). It is usually set to express the amounts for the fields that end with 'xxxInReportCcy'.OptionalThe default value is notional currency.Pricing AnalysisBest Answer
-
Hi @thomas.j.tan ,
I understand that you are using refinitiv-dataplatform Python package. Please let me know if it's not the case. Below answer is related to that package.
There are several ways to get list of supported parameters:
- Use automatic code completion in your IDE. See example: code-completion.png
- Go to class definition in your IDE. See example:go-to-definition.png
- Open following file and all parameters will be listed there - %Your_Python_Folder%\Lib\site-packages\refinitiv\dataplatform\content\ipa\contracts\bond\_bond_pricing_parameters.py
For reference: full list of parameters supported by API can be found at API Playground > "/data/quantitative-analytics/v1/financial-contracts" > Swagger. However you may need to query API directly to use some of them. Not all parameters may be supported by mentioned Python package.
Let me know if you have any other questions.
Thanks,
Mark
0
Answers
-
Does the following work for you?
report_ccy = "USD"
I am trying to find a complete list for your reference.
0 -
Note that the API Playground parameters may use different case e.g. camelCase whereas the RDP Python Library uses conventional python snake_case for the parameter names e.g.
- API Playground: reportCCy
- RDP python Library: report_ccy
0
Categories
- All Categories
- 6 AHS
- 37 Alpha
- 161 App Studio
- 4 Block Chain
- 4 Bot Platform
- 16 Connected Risk APIs
- 47 Data Fusion
- 30 Data Model Discovery
- 608 Datastream
- 1.3K DSS
- 577 Eikon COM
- 4.9K Eikon Data APIs
- 7 Electronic Trading
- Generic FIX
- 7 Local Bank Node API
- Trading API
- 2.7K Elektron
- 1.3K EMA
- 236 ETA
- 519 WebSocket API
- 33 FX Venues
- 10 FX Market Data
- 1 FX Post Trade
- 1 FX Trading - Matching
- 12 FX Trading – RFQ Maker
- 5 Intelligent Tagging
- 2 Legal One
- 20 Messenger Bot
- 2 Messenger Side by Side
- 9 ONESOURCE
- 7 Indirect Tax
- 59 Open Calais
- 264 Open PermID
- 39 Entity Search
- 2 Org ID
- PAM
- PAM - Logging
- 8.4K Private Comments
- 6 Product Insight
- Project Tracking
- ProView
- ProView Internal
- 20 RDMS
- 1.4K Refinitiv Data Platform
- 367 Refinitiv Data Platform Libraries
- 3 Refinitiv Due Diligence
- LSEG Due Diligence Portal API
- 3 Refinitiv Due Dilligence Centre
- Rose's Space
- 1.1K Screening
- 18 Qual-ID API
- 13 Screening Deployed
- 23 Screening Online
- 10 World-Check Customer Risk Screener
- 990 World-Check One
- 44 World-Check One Zero Footprint
- 45 Side by Side Integration API
- Test Space
- 3 Thomson One Smart
- 1.2K TR Internal
- Global Hackathon 2015
- 2 Specialists Who Code
- 10 TR Knowledge Graph
- 150 Transactions
- 142 REDI API
- 1.7K TREP APIs
- 4 CAT
- 21 DACS Station
- 117 Open DACS
- 1.1K RFA
- 103 UPA
- 172 TREP Infrastructure
- 224 TRKD
- 886 TRTH
- 5 Velocity Analytics
- 5 Wealth Management Web Services
- 59 Workspace SDK
- 9 Element Framework
- 5 Grid
- 13 World-Check Data File
- Yield Book Analytics
- 46 中文论坛