Discover Refinitiv
MyRefinitiv Refinitiv Perspectives Careers
Created with Sketch.
All APIs Questions & Answers  Register |  Login
Ask a question
  • Questions
  • Tags
  • Badges
  • Unanswered
Search:
  • Home /
  • DSS /
avatar image
Question by johan.lundquist · Dec 04, 2018 at 04:26 AM · dss rest apiequitysearch

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"
}
]
}

People who like this

0 Show 0
Comment
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

5 Replies

  • Sort: 
avatar image
REFINITIV
Best Answer
Answer by gteage01 · Dec 04, 2018 at 05:20 AM

@johan.lundquist

Hi Johan,

Replicate API via GUI (Equity Search)

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


screenshot.png (48.0 KiB)
Comment

People who like this

0 Show 0 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

avatar image
Answer by johan.lundquist · Dec 04, 2018 at 08:12 AM

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

Comment

People who like this

0 Show 1 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

avatar image
REFINITIV
Christiaan Meihsl ♦♦ · Dec 04, 2018 at 08:33 AM 0
Share

@johan.lundquist, sorry, there is no such parameter.

avatar image
REFINITIV
Answer by Christiaan Meihsl · Dec 04, 2018 at 08:22 AM

@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:


0440hk.png (97.3 KiB)
Comment

People who like this

0 Show 1 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

avatar image
REFINITIV
Christiaan Meihsl ♦♦ · Dec 06, 2018 at 03:38 AM 0
Share

@johan.lundquist,

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)
avatar image
Answer by johan.lundquist · Dec 04, 2018 at 08:32 AM

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

Comment

People who like this

0 Show 2 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

avatar image
REFINITIV
Christiaan Meihsl ♦♦ · Dec 04, 2018 at 08:37 AM 0
Share

@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.

avatar image
johan.lundquist Christiaan Meihsl ♦♦ · Dec 04, 2018 at 08:40 AM 0
Share

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

avatar image
Answer by johan.lundquist · Dec 06, 2018 at 04:20 AM

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

Comment

People who like this

0 Show 2 · Share
10 |1500 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

avatar image
REFINITIV
Christiaan Meihsl ♦♦ · Dec 06, 2018 at 07:47 AM 0
Share

@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

avatar image
johan.lundquist Christiaan Meihsl ♦♦ · Dec 06, 2018 at 08:24 AM 0
Share

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

Watch this question

Add to watch list
Add to your watch list to receive emailed updates for this question. Too many emails? Change your settings >
12 People are following this question.

Related Questions

DSS - REST API - Configurable/Additional response fields via Search/EquitySearch?

I'm getting more rows that requested on bond ratings request over DSS REST API

TickHistoryTimeAndSalesExtractionRequest - Getting last price nearest to a date

Get content for a specific date (or date range)

Could you please let me know, Will API return only positive rate values or negative rate values also ?

  • Feedback
  • Copyright
  • Cookie Policy
  • Privacy Statement
  • Terms of Use
  • Careers
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Alpha
  • App Studio
  • Block Chain
  • Bot Platform
  • Calais
  • Connected Risk APIs
  • DSS
  • Data Fusion
  • Data Model Discovery
  • Datastream
  • Eikon COM
  • Eikon Data APIs
  • Electronic Trading
    • Generic FIX
    • Local Bank Node API
    • Trading API
  • Elektron
    • EMA
    • ETA
    • WebSocket API
  • Legal One
  • Messenger Bot
  • Messenger Side by Side
  • ONESOURCE
    • Indirect Tax
  • Open PermID
    • Entity Search
  • Org ID
  • PAM
    • PAM - Logging
  • ProView
  • ProView Internal
  • Product Insight
  • Project Tracking
  • Refinitiv Data Platform
    • Refinitiv Data Platform Libraries
  • Rose's Space
  • Screening
    • Qual-ID API
    • Screening Deployed
    • Screening Online
    • World-Check One
    • World-Check One Zero Footprint
  • Side by Side Integration API
  • TR Knowledge Graph
  • TREP APIs
    • CAT
    • DACS Station
    • Open DACS
    • RFA
    • UPA
  • TREP Infrastructure
  • TRIT
  • TRKD
  • TRTH
  • Thomson One Smart
  • Transactions
    • REDI API
  • Velocity Analytics
  • Wealth Management Web Services
  • World-Check Data File
  • Explore
  • Tags
  • Questions
  • Badges