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

gteage01 · March 2017

Question: "I am trying to use the DSS Rest API to query
instrument data. I have been using the /Search/EquitySearch functionality to
search for instruments based on their ISIN and market and get results as
expected. However, from the documentation it looks as though I should be able
to retrieve more fields than I actually receive, and I can't figure out how to
change this. An example request and reply is:

POST https://hosted.datascopeapi.reuters.com/RestApi/v1/Search/EquitySearch HTTP/1.1

{"SearchRequest":{"IdentifierType":"Isin","Identifier":"GB00BH4HKS39","PreferredIdentifierType":"Ric","AssetStatus":"Active","ExchangeCodes":["LSE"]}}

"Identifier":"VOD.L","IdentifierType":"Ric","Source":"LSE","Key":"VjF8MHgwMDAzZGQwMDE0OGU3NDMwfDB4MDAwM2RjMDAzNDdjOTEwNnxMU0V8RVFRVXxFUVRZfHxFfHxWT0QuTHwwNjkx","Description":"VODAFONE
GROUP
ORD","InstrumentType":"EquityQuote","Status":"Valid"

I would also like to find the listing
currency, the attached screenshot from the API help suggests returned entities
should be ValidatedInstrument with several additional fields, including
"CurrencyCodes". Am I misunderstanding the meaning of the API help or
is this possible? If not please would you suggest the best way of extracting
the listing currency by some other query/extraction."

Christiaan Meihsl · March 2017

@gteage01

I see what you mean. For an equity search the REST API Reference Tree mentions more fields than what is returned. I will escalate this.

To get the currency code you can use a Terms and Conditions request:

POST https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/Extract

Body:

{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
        "ContentFieldNames": [
           "RIC", "ISIN", "Currency Code"
        ],
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "GB00BH4HKS39",
                    "IdentifierType": "Isin"
                }
            ]
        }
    }
}

Response:

{
  "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#Collection(ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.ExtractionRow)",
  "value": [
    {
      "IdentifierType": "Isin",
      "Identifier": "GB00BH4HKS39",
      "RIC": "VOD.L",
      "ISIN": "GB00BH4HKS39",
      "Currency Code": "GBp"
    }
  ]
}

Hope this helps.

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

Best Answer

Categories

EXPLORE OUR SITES

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

Best Answer

Categories