DataScope Select - REST API: /EquitySearch wish only one RIC back
Hi,
I expect to get a 1to1 relation between {ISIN,CURRENCY,EXCHANGE} and RIC, but below provides me with 1to4 and I don't see logical differences between the RICs? Please advise.
Endpoint: /RestApi/v1/Search/EquitySearch
Body:
{
"SearchRequest": {
"AssetStatus": "Active",
"AssetCategoryCodes": null,
"SubTypeCodes": null,
"CurrencyCodes": [ "HKD" ],
"CompanyName": null,
"Description": null,
"DomicileCodes": null,
"ExchangeCodes": [ "HKG" ],
"FairValueIndicator": null,
"FileCodes": null,
"GicsCodes": null,
"OrgId": null,
"Ticker": null,
"Identifier": "HK0440001847",
"IdentifierType": "Isin",
"PreferredIdentifierType": "Ric"
}
}
Result:
"@odata.context": ".../RestApi/v1/$metadata#Collection(ThomsonReuters.Dss.Api.Search.EquitySearchResult)",
"value": [
{
"Identifier": "0440stat.HK",
"IdentifierType": "Ric",
"Source": "HKG",
"Key": "VjF8MHgwMDAzZGQwMDEzNWVmNzY0fDB4MDAwM2RkMDUwNGU1YWY5NXxIS0d8RVFRVXxFUVRZfE9EU0h8RXx8MDQ0MHN0YXQuSEt8MTMzOQ",
"Description": "DAH SING ORD",
"InstrumentType": "EquityQuote",
"Status": "Valid",
"DomicileCode": "HK",
"CurrencyCodes": "HKD",
"SubTypeCode": "ODSH",
"AssetStatus": "Active",
"IssuerName": "DAH SING",
"IssuerOrgId": "18526",
"Exchange": "HKG",
"FileCode": "1339"
},
{
"Identifier": "0440.HK",
"IdentifierType": "Ric",
"Source": "HKG",
"Key": "VjF8MHgwMDAzZGQwMDEzNWVmNzY0fDB4MDAwM2Y4MDFmYWVkZDczYXxIS0d8RVFRVXxFUVRZfE9EU0h8RXx8MDQ0MC5IS3wwMDAx",
"Description": "DAH SING ORD",
"InstrumentType": "EquityQuote",
"Status": "Valid",
"DomicileCode": "HK",
"CurrencyCodes": "HKD",
"SubTypeCode": "ODSH",
"AssetStatus": "Active",
"IssuerName": "DAH SING",
"IssuerOrgId": "18526",
"Exchange": "HKG",
"FileCode": "1"
},
{
"Identifier": "0440.HS",
"IdentifierType": "Ric",
"Source": "HKG",
"Key": "VjF8MHgwMDAzZGQwMDEzNWVmNzY0fDB4MDAxMDBiMDAwYjAzN2VlYnxIS0d8RVFRVXxFUVRZfE9EU0h8RXx8MDQ0MC5IU3wzMjAw",
"Description": "DAH SING ORD",
"InstrumentType": "EquityQuote",
"Status": "Valid",
"DomicileCode": "HK",
"CurrencyCodes": "HKD",
"SubTypeCode": "ODSH",
"AssetStatus": "Active",
"IssuerName": "DAH SING",
"IssuerOrgId": "18526",
"Exchange": "HKG",
"FileCode": "3200"
},
{
"Identifier": "0440.HZ",
"IdentifierType": "Ric",
"Source": "HKG",
"Key": "VjF8MHgwMDAzZGQwMDEzNWVmNzY0fDB4MDAxMDBiMDAxMzQwNGE0Y3xIS0d8RVFRVXxFUVRZfE9EU0h8RXx8MDQ0MC5IWnwzNTA4",
"Description": "DAH SING ORD",
"InstrumentType": "EquityQuote",
"Status": "Valid",
"DomicileCode": "HK",
"CurrencyCodes": "HKD",
"SubTypeCode": "ODSH",
"AssetStatus": "Active",
"IssuerName": "DAH SING",
"IssuerOrgId": "18526",
"Exchange": "HKG",
"FileCode": "3508"
}
]
}
Hi Johan,
After checking what results would be provided via the GUI, it doesn't appear to be a API question. A Case can be raised Raise a Case (Register) to:
a) check if the links are correct between ISIN to RIC, and also
b) if it is correct for the Exchange Code to be the same as "HKG" for all 4 RICs with varying suffixes of *.HK, *.HS., *.HZ and containing *stat*.HZ are all correct.
I see the issue in that you want to get back a unique row but given the underlying Content being provided and the Equity search I don't believe (in the case of using ISIN) the API has any functionality to narrow the results further to return only a single unique record.
Unless this can be narrowed by Content further somehow in terms of RIC suffix returning different Exchange Code, the workflow to be considered might have to retrieve multiple records then decide which RIC to use by RIC syntax.
Best regards,
Gareth
Thank you Gareth,
I'll raise a ticket on content in such case. I hoped for an API solution with by example a parameter for "Primary":"True".
Kind regards,
Johan
@johan.lundquist, I agree with Gareth:
- This is not API related, this is a pure data query. I'm not a data specialist, but I'd say that the main RIC is 0440.HK.
- Obviously you will need to filter the results. For the HKG exchange filtering to contain only RICs with suffix .HK seems reasonable to me (but again, better check with a data specialist).
0440stat.HK contains different data (compared to the other 3 that all have the same data), it looks like some kind of calculated RIC. It displays differently in Eikon too, and states that the underlying is 0440.HK:
Here is an explanation on the 4 extensions:
- .HK: Primary Listing RIC
- "stat" + ".HK": Short Selling Data
- .HS: Shanghai Hong Kong connect (it is an alias RIC, i.e. a mirror image)
- .HZ: Shenzhen Hong Kong connect (alias RIC)
The output is supposed to become a primary key so I would need my service to identify the correct one based on the return only.
For the *.HK it would require me to maintain a translation table of exchange code to RIC-subfix if I understand you correctly? It would of course be ideal to avoid that but sure it may be an okay workaround.
Kind regards,
Johan
@johan.lundquist, I understand your predicament.
The best is to start by getting an explanation for why we have 4 RICs: is this normal, or an error in the data ?
If it is an error then we need to correct our data, but I doubt it is an error, because these instruments also have differing Sedols, so there must be a logical explanation.
If you are in a hurry then I suggest you start with the workaround you mentioned, even if that is not ideal.
Yes ticket raised on content 07159599, I'll update this post with outcome from that which can affect the design I go for.
Thanks,
Johan
After discussion with customer support it seems another end point could fit my needs better
https://select.datascopeapi.extranet.reuters.biz/RestApi/v1/Extractions/ExtractWithNotes
Takes a list of Identifiers, ISIN in my case, and return for primary listing {RIC, CCY, EXC}.
I will continue work towards that end point, thank you for support.
Kind regards,
Johan
@johan.lundquist, thank you for mentioning this.
The ExtractWithNotes endpoint can be used with many different extraction requests, defined by the data type. Am I correct in assuming that the extraction data type is a T&C (Terms and Conditions) request ?
T&C will return the primary RIC. It is also possible to request the RIC for a specific exchange. on this theme, this article on ISIN to RIC conversion using TRTH could be of interest to you.
Kind regards, Christiaan
Yes you are right >> "@odata.type":"#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest"
I'll take a look at the enclosed link, thanks.
Kind regards,
Johan