For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
gteage avatar image
406 ●6 ●2 ●6

GUI successfully extracts data using OCC, can't seem to get the equivalent to work in API

Hi,

After my API call to DSS failed to recognise my Identifier: SINA150612C00057000, with Identifier Type: OCCCode ('Not Found') I tried the extraction using GUI for the same Identifier and I am not sure what I am doing wrong by the GUI extraction worked fine, just want to replicate the same success via API On Demand, my unsuccessful extraction below:

POST .../Extractions/ExtractWithNotes 

{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
        "ContentFieldNames": [
            "Asset Category",
            "Trading Symbol",
            "OCC Code",
            "RIC"
        ],
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "SINA150612C00057000",
                    "IdentifierType": "OCCCode"
                }
            ],
            "ValidationOptions": {
                "AllowHistoricalInstruments": false,
                "AllowInactiveInstruments": false,
                "AllowLimitedTermInstruments": false,
                "AllowOpenAccessInstruments": false,
                "AllowSubclassImport": false,
                "AllowUnsupportedInstruments": true,
                "ExcludeFinrAsPricingSourceForBonds": false,
                "UseConsolidatedQuoteSourceForCanada": false,
                "UseConsolidatedQuoteSourceForUsa": false,
                "UseDebtOverEquity": false,
                "UseExchangeCodeInsteadOfLipper": true,
                "UseOtcPqSource": true,
                "UseUsQuoteInsteadOfCanadian": true
            },
            "UseUserPreferencesForValidationOptions": false
        },
        "Condition": null
    }
}
{
    "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.ExtractionResult",
    "Contents": [
        {
            "IdentifierType": "OCCCode",
            "Identifier": "SINA150612C00057000",
            "Error": "Not found"
        }
    ],
    "Notes": [
        "All identifiers were invalid.  No extraction performed."
    ]
}
dss-rest-apidatascope-selectdss
icon clock
10 |1500

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

wasin.w avatar image   wasin.w

Hello @gareth.teage

Thank you for your participation in the forum. Is the reply below satisfactory in resolving your query?


If so please can you click the 'Accept' text next to the appropriate reply? This will guide all community members who have a similar question.

Thanks,


AHS


Jirapongse avatar image   Jirapongse

@gareth.teage

Hi,

Please be informed that a reply has been verified as correct in answering the question, and has been marked as such.

Thanks,

AHS

2 Answers

· Write an Answer
Upvotes
Accepted
Jirapongse avatar image
79.1k ●250 ●52 ●74

@gareth.teage

I assume that when using GUI, you have used Futures & Options Search to search for SINA150612C00057000 (OCCCode). The search result is a RIC that is added to the instrument list.


You can do the same in the API.

1. Use Search/FuturesAndOptionsSearch to search for SINA150612C00057000 (OCCCode)

{
    "SearchRequest": {
        "FileCodes": null,
        "CurrencyCodes": null,
        "ExchangeCodes": null,
        "IdentifierType": "OCCCode",
        "Identifier": "SINA150612C00057000",
        "PreferredIdentifierType": "Ric"
    }
}

2. The output is:

    "value": [
        {
            "Identifier": "SINAF121505700.U",
            "IdentifierType": "Ric",
            "Source": "OPQ",
...
            "Description": "SINA 2Jn5 57.0 C",
            "InstrumentType": "Derivative",
            "Status": "Valid",
            "ExchangeCode": "OPQ",
            "CurrencyCode": "USD",
            "FuturesAndOptionsType": "Options",
            "PutCallCode": "Call",
            "ExpirationDate": "2015-06-12T00:00:00.000Z",
            "StrikePrice": 57,
            "AssetStatus": "Active"
        }
    ]

3. Then use the returned RIC (SINAF121505700.U) in the extraction

{
    "ExtractionRequest": {
        "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
        "ContentFieldNames": [
            "Asset Category",
            "Trading Symbol",
            "OCC Code",
            "RIC"
        ],
        "IdentifierList": {
            "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
            "InstrumentIdentifiers": [
                {
                    "Identifier": "SINAF121505700.U",
                    "IdentifierType": "Ric"
                }
            ],
            "ValidationOptions": {
                "AllowHistoricalInstruments": false,
                "AllowInactiveInstruments": false,
                "AllowLimitedTermInstruments": false,
                "AllowOpenAccessInstruments": false,
                "AllowSubclassImport": false,
                "AllowUnsupportedInstruments": true,
                "ExcludeFinrAsPricingSourceForBonds": false,
                "UseConsolidatedQuoteSourceForCanada": false,
                "UseConsolidatedQuoteSourceForUsa": false,
                "UseDebtOverEquity": false,
                "UseExchangeCodeInsteadOfLipper": true,
                "UseOtcPqSource": true,
                "UseUsQuoteInsteadOfCanadian": true
            },
            "UseUserPreferencesForValidationOptions": false
        },
        "Condition": null
    }
}

You may contact the DSS support team via MyRefinitiv to verify why the OCCCode doesn't work with the TermsAndConditionsExtractionRequest.


1608782142162.png (7.8 KiB)
icon clock
10 |1500

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

Upvotes
yingwu avatar image
1 ●0 ●0 ●0

We found that you can use IdentifierType = Sym in the extract call instead of OCCCode and it works.

Sym = Trading Symbol = Exchange-supplied code used for trading purposes to uniquely identify an instrument.


"IdentifierType": "Sym"
icon clock
10 |1500

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

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

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