Is it possible to get Instrument's Cross Reference data via DataScope REST API?

cabissi

In DataScope, after I search on Cusip and get a list of items, clicking open one of the items will open the attached screen. Is any of the data in Cross Reference tab exposed via DataScope REST API? I am primarily trying to get the values for Original Place of Listing -> Price Source under Symbols section and the Identifier Type/Identifier under Cross Reference section. Thanks!

gteage

Hi @cabissi

Yes the API can do this, and provide much more data via View & Extract.

In the .NET Example Application the 'On Demand' Direct HTTP example is:

POST https://hosted.datascopeapi.reuters.com/RestApi/v1/Extractions/ExtractWithNotes HTTP/1.1
Authorization: Token <your_auth_token_goes_here>
Prefer: respond-async
Content-Type: application/json; odata=minimalmetadata
{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.SymbolCrossReferenceExtractionRequest",
        "ContentFieldNames": [
            "Quote ID",
            "Asset Type",
            "Asset Type Description",
            "Security Description",
            "Instrument ID",
            "Instrument ID Type",
            "Reuters Editorial RIC"
        ],
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "IBM.N",
                    "IdentifierType": "Ric"
                }
            ],
            "ValidationOptions": null,
            "UseUserPreferencesForValidationOptions": false
        },
        "Condition": {
            "IdentifierTypes": [
                "Ric",
                "Sedol",
                "Cusip",
                "Wertpapier",
                "Valoren"
            ],
            "DaysAgo": 14,
            "AllXRefIdentifierTypes": true
        }
    }
}

The full model for this On Demand example can be viewed via the API Reference Tree: https://hosted.datascopeapi.reuters.com/RestApi.Help/Context/Operation?ctx=Extractions&opn=ExtractWithNotes&grp=On%20Demand%20Extraction (select ExtractionRequestBase = SymbolCrossReferenceExtractionRequest)

The .NET Example Application as well as other key resources can be found here (GUI : Help > REST API Help): https://hosted.datascopeapi.reuters.com/RestApi.Help/Home/Index , I'd recommend some of the pages such as 'Key Mechanisms' and 'Extraction Limits' in the 'SDK' menu, as well as the 'Best Practices' guide located in the Developer Community: https://developers.refinitiv.com/en/api-catalog/datascope-select/datascope-select-rest-api/documentation#best-practices-and-limits-for-data-scope-select, one of the key parts of the API is to get the bearer Token (valid for 24 hours) from the response to re-use the Token in any requests the the DSS API in the 24 hour period:

POST https://hosted.datascopeapi.reuters.com/RestApi/v1/Authentication/RequestToken HTTP/1.1
Prefer: respond-async
Content-Type: application/json; odata=minimalmetadata
{
    "Credentials": {
        "Username":  "<Your Username>",
        "Password":  "<Your Password>"
    }
}

Best regards,

Gareth