question

ricardo.siguero avatar image
5 5 9 10

Corporate Action data retrieval (Stored & sheduled approach)

Hi all,

Is there a way of retrieving Corporate Action (CA) data by using the 'Stored & Scheduled' (instrument list+report template+schedule) approach of the REST Api?

The case shown at the "Use Cases Reference" document for Corporate Action data retrieval shows the use of the 'ExtractWithNotes' endpoint.that follows the "On Demand" approach.

We need to specify a date range (from date/end date) but the three CA-related report templates documented on the API seems not to use such kind of criteria...

Any feedback will be appreciated.

Ricardo

tick-history-rest-apirest-apicorporate-actions
10 |1500

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

1 Answer

veerapath.rungruengrayubkul avatar image
11.3k 25 8 13

@ricardo.siguero

You can follow the steps in the REST API Tutorial 12: GUI control calls: immediate extract tutorial for "Stored & Scheduled" extraction type. You also need to change the report template to CorporateActionsStandardReportTemplates.

Below is the sample request for creating the Corporate Actions Standard report template with date range specific.

{
    "@odata.type": "#ThomsonReuters.Dss.Api.Extractions.ReportTemplates.CorporateActionsStandardReportTemplate",
    "ShowColumnHeaders": false,
    "Name": "CorporateActionsStandard",
    "Headers": [
        
    ],
    "Trailers": [
        
    ],
    "ContentFields": [
        {
            "FieldName": "Adjustment Factor",
            "Format": null
        },
        {
            "FieldName": "Capital Change Announcement Date",
            "Format": null
        },
        {
            "FieldName": "Currency Code",
            "Format": null
        },
        {
            "FieldName": "Exchange Code",
            "Format": null
        }
    ],
    "Condition": {
        "ReportDateRangeType": "Range",
        "QueryStartDate": "2017-09-11T00:00:00.000Z",
        "QueryEndDate": "2017-09-13T23:59:59.000Z",
        "ExcludeDeletedEvents": true,
        "IncludeCapitalChangeEvents": true,
        "IncludeDividendEvents": true,
        "IncludeEarningsEvents": true,
        "IncludeMergersAndAcquisitionsEvents": true,
        "IncludeNominalValueEvents": true,
        "IncludePublicEquityOfferingsEvents": true,
        "IncludeSharesOutstandingEvents": true,
        "IncludeVotingRightsEvents": true,
        "CorporateActionsCapitalChangeType": "CapitalChangeExDate",
        "CorporateActionsDividendsType": "DividendPayDate",
        "CorporateActionsEarningsType": "PeriodEndDate"
    }
}

This request will create the following template in GUI.


10 |1500

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