Response fields in search requests
Running this of your postman examples:Tuto-11a: Search by RIC
Is is possible to add additional fields to the response like getting RIC, ISIN, Currency code, etc. in the response? At the moment we are just getting a fixed amount of response fields like these:
"Identifier": "VOD.L",
"IdentifierType": "Ric",
"Source": "LSE",
"Key": "VjF8MHgwMDAzZGQwMDE0OGU3NDMwfDB4MDAwM2RjMDAzNDdjOTEwNnxMU0V8RVFRVXxFUVRZfHxFfHxWT0QuTHwwNjkx",
"Description": "VODAFONE GROUP ORD",
"InstrumentType": "EquityQuote",
"Status": "Valid"
Of course the Identifier field can be changed by defining a prefered identifer type, but is is possible to generally add additional response fields?
Thx in advance!
Best Answer
-
The output field set of a Search (as wll as EquitySearch and FuturesAndOptionsSearch) is not configurable.
But as filter criteria of those 2 search calls you can use multiple exchange codes, and/or a single currency code.
Here is the body of an equity search based on Tutorial 12, modified for your use case:{
"SearchRequest": {
"AssetStatus": "Active",
"AssetCategoryCodes": null,
"SubTypeCodes": null,
"CurrencyCodes": ["GBp"],
"CompanyName": null,
"Description": null,
"DomicileCodes": null,
"ExchangeCodes": [
"CHI", "GER", "LSE", "OTC", "PAR", "STO"
],
"FairValueIndicator": null,
"FileCodes": null,
"GicsCodes": null,
"OrgId": null,
"Ticker": null,
"Identifier": "GB00BH4HKS39",
"IdentifierType": "Isin",
"PreferredIdentifierType": "Ric"
}
}Would that be of any help ?
0
Answers
-
@Philipp, as far as I know, the set of fields returned by a search is not configurable.
That said, for the specific use case you mention (i.e. getting other instrument codes or the currency), you can use a Terms and Conditions extraction to retrieve them. See the REST API Tutorial 7. Note that this is one of several possibilities, as there are several extraction types that can deliver multiple instrument codes.
0 -
What we do is we have a long list of ISINs (+Exchange Code/Currency Code) each day, lets say 700. And we want to find the related RICs. So best for us would be to have a search extraction type with at least these three search fields (that is already available) and that is giving us a list with RICs and all the fields that where in our search request (exchange code and currency in this case). In some special situations like with currencies GBP and GBp we then can determinate with currency is related to the RIC without performing an additional extraction. It there an existing way to acive this? Is it possible to extend the "Search/EquitySearch" extraction to show all the fields we passed in a parameters as well in the response?
Thanks a lot in advance!
0 -
Thanks a lot, that was really helpful.
Still we have a problem with this extraction type. When we for example request for ISIN GB00BH4HKS39 we only get one result, but this ISIN is linked to a lot of RICs at different exchanges and in different currencies. So this extraction type if fine to check the currency for a single or multiple RICs, but still we need to make two separate calls to search a RIC for a known ISIN.
0 -
@Philipp
The T&C extraction call (illustrated in REST API Tutorial 7) call can return many fields, including the Exchange Code and Currency Code, but it returns only the primary RIC for each ISIN (VOD.L for this particular case).
An instrument search (illustrated in REST API Tutorial 11) will return all RICs for a given ISIN, but the output field set is not configurable.0 -
Thx for your help. So, there is no combination of both features at the moment? In that case we will implement two calls of the REST API, that will work but be a bit slower / cause more overhead.
Do you think it would be possible to extend the existing instrument search by one more field (currency code) in the near future?
0 -
There is no combination of both features. But for equity search you can use the currency code, as filtering criteria, as illustrated in the answer I posted a few minutes ago. Same goes for Futures and Options searches by the way. Would that suffice for your needs ?
0 -
Thanks for your help!
That will work for us, we will then have to make multiple requests, each with only one currency code (e.g. first for GBP and then for GBp).
Thx!
0 -
Last question then: Would it be possible to extend the EquitySearch and FuturesAndOptionsSearch result by currency code?
0 -
You would like us to add the currency code to the results ? Considering you can make a search using a (single) currency code, what advantage would this bring ?
0 -
I could then send a list of currency codes in the request (e.g. GBP and GBp) and for example get only one result. I can then extract the RIC and know with currency this RIC is using. We even have the situation, were we are searching RICs with longer lists of currency codes. It is for us very important to have the RIC exactly in the currency the customers is trading in.
As you described we can make this with multiple requests too. The currency in the response would just avoid, multiple requests. I see benefits in less server load, performance and development efforts on our side.
0 -
I see your point if the request does not include a currency.
But if you filter on currencies, as this request only supports one single currency (i.e. not multiple values), the results will be limited to a single currency, making the output of a currency field useless.
0 -
Yes, if we are making single currency requests, this additional output is not necessary. Your are right.
But usually we have one ISIN, a list of exchange codes and a list of currency codes and want to know what RICs are available. In that case it would be great to make just one larger request and then to filter the response on our side by using the source field and (a possible new) currency field in the response output.
0 -
Let my clarify. A search query will not accept several currency codes as input, it is limited to 1 single currency. If you put more than 1 currency code in the request you will receive an error message: CurrencyCodes currently only supports a single value.
A currency code in the output would therefore only be useful for requests that do not use a currency code in the request.
0 -
Ok, sorry for the confusion.
I was sure I have executed the request with multiple currency codes in our initial tests. Now I am getting the same message.
Maybe I mixed it with the exchange code list, and because both are array types.
Thanks for your help!
Just a last question, would it be possible to support multiple currency codes in the request and to show the RIC related currency code in the response? That still would really help us.
0 -
Welcome ! I have escalated your query to the product group.
0 -
I just tried to use this request with an option RIC. It was not delivering a result, maybe you can help/explain this?
POST [...] /Extractions/Extract
Body: "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#Collection(ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.ExtractionRow)",[..]
"ContentFieldNames": [ "RIC", "Currency Code", "Exchange Code", "Exchange Code List"
[..]
"Identifier": "DTEGn150bX6.EX", "IdentifierType": "Ric"
[..]
Other RICs are working fine, but this option RIC is returning:
"Identifier": "DTEGn150bX6.EX", "Error": "Not found",
0 -
I see the same issue. I can manage to get result with the following steps. However, the other fields except "RIC" return null. It's likely because the RIC is inactive. The extraction note also states "WARNING: Instrument 'DTEGn150bX6.EX' is only valid for Intraday extractions"
1) Selected the "Allow Import of..." in the User Preferences of DSS Web UI.
2) Once the request is created, please add the UseUserPreferencesForValidationOptions: true in the "IdentifierList".
"IdentifierList": {...,
"UseUserPreferencesForValidationOptions": true0
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
- 687 Datastream
- 1.4K DSS
- 622 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
- 254 ETA
- 557 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
- 276 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
- 675 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
- 229 TRKD
- 918 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
- 48 中文论坛