| Last update | Dec 2023 |
| Environment | Any |
| Language | Any HTTP is supported |
| Compilers | None |
| Prerequisites | DSS login, internet access |
| Source code | Below |
This tutorial explains how to:
This step is optional. If you do not know what content field names are available, you can request a list of those available.
URL:
The available field set depends on the type of data you want to request. The data type must therefore be specified in the request, which is done by setting a report template type in the URL. As we want corporate actions data we set a value of CorporateActions. The preceding and following tutorials show other possibilities.
https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/GetValidContentFieldTypes(ReportTemplateType=DataScope.Select.Api.Extractions.ReportTemplates.ReportTemplateTypes'CorporateActions')
Method: GET
Headers:
Note: for all requests we need a user token, set in the header. The token was retrieved in Tutorial 1.
Prefer: respond-async
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061
Content-Type: application/json; charset=utf-8
Body:
There are more than 300 values in the response. Here is the beginning of the response:
{
"@odata.context": "https://selectapi.datascope.refinitiv.com/RestApi/v1/$metadata#ContentFieldTypes",
"value": [
{
"Code": "COR.Accounting Standard",
"Name": "Accounting Standard",
"Description": "Code indicating the accounting standard used in accounts in which the EPS figure is reported",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "COR.Acquirer Company Name",
"Name": "Acquirer Company Name",
"Description": "Name of the acquiring party",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "COR.Acquirer RIC",
"Name": "Acquirer RIC",
"Description": "RIC of primary issue of acquirer",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "COR.Acquirer Row ID",
"Name": "Acquirer Row ID",
"Description": "Unique system-assigned identifier for the acquiring party",
"FormatType": "Number",
"FieldGroup": " "
},
{
"Code": "COR.Actual Adjustment Factor",
"Name": "Actual Adjustment Factor",
"Description": "Actual or as-reported adjustment factor expressing the dilutive effect of the capital change event on per share values",
"FormatType": "Number",
"FieldGroup": " "
},
This goes on with all the other available fields. Here is the last part:
{
"Code": "COR.Wertpapier",
"Name": "Wertpapier",
"Description": "Issue-level code used for identifying instruments in Germany",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "COR.Withdrawn Date",
"Name": "Withdrawn Date",
"Description": "Date on which the offer was withdrawn",
"FormatType": "Date",
"FieldGroup": " "
},
{
"Code": "COR.Zip Code",
"Name": "Zip Code",
"Description": "Current zip code of the organization",
"FormatType": "Text",
"FieldGroup": " "
}
]
}
https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/ExtractWithNotes
Method: POST
Headers:
Prefer: respond-async
Content-Type: application/json
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061
Body:
The body of the request must mention it is an extraction request. It contains several parts:
{
"ExtractionRequest": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.CorporateActionsStandardExtractionRequest",
"ContentFieldNames": [
"Corporate Actions Type",
"Capital Change Event Type",
"Capital Change Event Type Description",
"Actual Adjustment Type",
"Actual Adjustment Type Description",
"Adjustment Factor",
"Currency Code",
"Exchange Code",
"Effective Date",
"Dividend Pay Date",
"Dividend Rate",
"Nominal Value",
"Nominal Value Currency",
"Nominal Value Date"
],
"IdentifierList": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{ "Identifier": "438516AC0", "IdentifierType": "Cusip" },
{ "Identifier": "ALVG.DE", "IdentifierType": "Ric" },
{ "Identifier": "IBM.N", "IdentifierType": "Ric" }
]
},
"Condition": {
"ReportDateRangeType": "Last",
"PreviousDays": 30,
"ExcludeDeletedEvents": true,
"IncludeCapitalChangeEvents": true,
"IncludeDividendEvents": true,
"IncludeEarningsEvents": true,
"IncludeMergersAndAcquisitionsEvents": true,
"IncludeNominalValueEvents": true,
"IncludePublicEquityOfferingsEvents": true,
"IncludeSharesOutstandingEvents": true,
"IncludeVotingRightsEvents": true,
"CorporateActionsCapitalChangeType": "CapitalChangeExDate",
"CorporateActionsDividendsType": "DividendPayDate",
"CorporateActionsEarningsType": "PeriodEndDate",
"ShareAmountTypes": [
]
}
}
}
Content-Type: application/json; charset=utf-8
Body:
{
"@odata.context": "https://selectapi.datascope.refinitiv.com/RestApi/v1/$metadata#DataScope.Select.Api.Extractions.ExtractionRequests.ExtractionResult",
"Contents": [
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "MNA",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "PEO",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": 2.56,
"Nominal Value Currency": "EUR",
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "SHO",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "VOT",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "NOM",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": "2018-08-14"
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "EAR",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "EAR",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "EAR",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "DIV",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": null,
"Dividend Pay Date": "2021-05-10",
"Dividend Rate": 9.6,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "ALVG.DE",
"Corporate Actions Type": "CAP",
"Capital Change Event Type": 13,
"Capital Change Event Type Description": "Non-renounceable rights issue in same stock",
"Actual Adjustment Type": "CCH",
"Actual Adjustment Type Description": "Capital Change - Adjusts Dividend and Earnings per Share, Pricing and Volume",
"Adjustment Factor": 1,
"Currency Code": "EUR",
"Exchange Code": "GER",
"Effective Date": "2007-05-03",
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "EAR",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "NOM",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": 0.2,
"Nominal Value Currency": "USD",
"Nominal Value Date": "2008-06-30"
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "DIV",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": "2021-03-10",
"Dividend Rate": 1.63,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "VOT",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "SHO",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "CAP",
"Capital Change Event Type": 21,
"Capital Change Event Type Description": "Stock split",
"Actual Adjustment Type": "CCH",
"Actual Adjustment Type Description": "Capital Change - Adjusts Dividend and Earnings per Share, Pricing and Volume",
"Adjustment Factor": 0.5,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": "1999-05-26",
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"Corporate Actions Type": "MNA",
"Capital Change Event Type": null,
"Capital Change Event Type Description": null,
"Actual Adjustment Type": null,
"Actual Adjustment Type Description": null,
"Adjustment Factor": null,
"Currency Code": "USD",
"Exchange Code": "NYS",
"Effective Date": null,
"Dividend Pay Date": null,
"Dividend Rate": null,
"Nominal Value": null,
"Nominal Value Currency": null,
"Nominal Value Date": null
}
],
"Notes": [
"Extraction Services Version 14.5.42294 (737b0965c07f), Built Apr 8 2021 13:46:55\r\nProcessing started at 04/20/2021 04:39:24.\r\nUser ID: 9008895\r\nExtraction ID: 519744702\r\nSchedule: _OnD_0x078615b5ab0c7773 (ID = 0x078615b5af0c7773)\r\nReporting the latest corporate actions.\r\nSuppressing Deleted Events\r\nReporting corporate actions with shares default type.\r\nInput List (3 items): _OnD_0x078615b5ab0c7773 (ID = 078615b5ac7c7773) Created: 04/20/2021 04:39:21 Last Modified: 04/20/2021 04:39:22\r\nSchedule Time: 04/20/2021 04:39:23\r\nReport Template (20 fields): _OnD_0x078615b5ab0c7773 (ID = 0x078615b5ab2c7773) Created: 04/20/2021 04:39:21 Last Modified: 04/20/2021 04:39:21\r\nProcessing completed successfully at 04/20/2021 04:39:31, taking 7.47 Secs.\r\nExtraction finished at 04/20/2021 04:39:31 UTC, with servers: x01a02, QSHC19 (4.9 secs), QSSHA1 (0.0 secs)\r\nUsage Summary for User 9008895, Client 65508, Template Type Corporate Actions, Standard Events\r\nBase Usage\r\n Instrument Instrument Terms Price\r\n Count Type Subtype Source Source\r\n------- ----------------------------------- ---------------------------- -------------- ----------------------------------------\r\n 2 Equities N/A N/A\r\n-------\r\n 2 Total instruments charged.\r\n 1 Instrument with no reported data.\r\n=======\r\n 3 Instruments in the input list.\r\nWriting RIC maintenance report.\r\n",
"Identifier,IdentType,Source,RIC,RecordDate,MaintType,OldValue,NewValue,Factor,FactorType\r\n"
]
}
No corporate actions apply to the bond, so there are no results for that instrument.
The Corporate Actions Type defines the event type:
| Value | Description |
|---|---|
| CAP | Capital change |
| DIV | Dividend |
| EAR | Earnings |
| MNA | Mergers and acquisitions |
| NOM | Nominal value |
| PEO | Public equity offering |
| SHO | Shares outstanding |
| VOT | Voting rights |
Depending on the event type, some fields will contain values, others, irrelevant to that case, will be null.