Commodities Screener in DataScope Select
Hello, Can you please share a sample code on how we can pull Commodities in the API, replicating how a Commodities Screener will do in the GUI?
Best Answer
-
It is a criteria list. You can use the DSS REST API to create criteria lists.
You can use the following request to create that Commodities screener.
{
"ListName": "CommodityCriteria1",
"Type": "Commodities",
"PreferredIdentifierType": "Ric",
"Filters": [
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.MultiValueFilter",
"Name": "Underlying Asset",
"Op": "In",
"Values": [
"Natural Gas"
]
},
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.BooleanFilter",
"Name": "Active Status",
"Value": "Yes"
},
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.BooleanFilter",
"Name": "Basis Gap Adjusted",
"Value": "All"
}
]
}Send it to the Extractions/CriteriaListCreate endpoint with the HTTP POST method. This request will create a criteria list named CommodityCriteria1.
The response will contain a ListId which can be used in on-demand extractions.
{
"@odata.context": "https://selectapi.datascope.refinitiv.com/RestApi/v1/$metadata#CriteriaLists/$entity",
"ListId": "0x085e7b6245988fd7",
"Name": "CommodityCriteria1",
"Type": "Commodities",
"PreferredIdentifierType": "Ric",
"Created": "2023-02-22T02:02:27.000Z",
"Modified": "2023-02-22T02:02:27.000Z",
"Filters": [
...
]
}For example, you can use the criteria list ID with the TermsAndConditionsExtractionRequest.
{
"ExtractionRequest": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
"ContentFieldNames": [
"RIC",
"Asset Type"
],
"IdentifierList": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentCriteriaListIdentifierList",
"CriteriaListId": "0x085e7b6245988fd7"
}
}
}Otherwise, you can specify the criteria filters directly in on-demand extractions.
{
"ExtractionRequest": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
"ContentFieldNames": [
"RIC",
"Asset Type"
],
"IdentifierList": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentCriteriaList",
"Filters": [
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.MultiValueFilter",
"Name": "Underlying Asset",
"Op": "In",
"Values": [
"Natural Gas"
]
},
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.BooleanFilter",
"Name": "Active Status",
"Value": "Yes"
},
{
"@odata.type": "#DataScope.Select.Api.Extractions.SubjectLists.BooleanFilter",
"Name": "Basis Gap Adjusted",
"Value": "All"
}
],
"PreferredIdentifierType": "Ric"
}
}
}However, this list contains more than 300,000 results which can exceed the extract limits defined on this page.
For more information regarding the criteria list endpoints, please refer to the DSS REST API Reference Tree.
0
Answers
-
@darshpatel Please see the following tutorial which has the code to replicate GUI functionality https://developers.refinitiv.com/en/api-catalog/datascope-select/datascope-select-rest-api/tutorials#rest-api-tutorial-10-gui-control-calls-immediate-extract. I hope this can help
0 -
hi @jason.ramchandani01 , thank you. However these are for instrument list. Commodities screener have criteria list. Hence i am not sure if it is the same thing?
0 -
thank you @Jirapongse , I will let client know the same
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 中文论坛