| Last update | Jan 2026 |
| Environment | Any |
| Language | Any HTTP is supported |
| Compilers | None |
| Prerequisites | DSS login, internet access |
| Source code | Below |
This tutorial explains how to:
If you do not know what field lists are available, you can request a list of those available.
The report template type must be specified in the path. As we want terms and conditions data we set a value of TermsAndConditions. The preceding On Demand request tutorials show other possibilities.
Note: for all requests we need a user token. This was retrieved in Tutorial 1.
URL:
https://selectapi.datascope.lseg.com/RestApi/v1/Extractions/GetValidContentFieldTypes(ReportTemplateType=DataScope.Select.Api.Extractions.ReportTemplates.ReportTemplateTypes'TermsAndConditions')
Method: GET
Headers:
Prefer: respond-async
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061
If the token is valid, this is the response we get:
Status: 200 OK
Relevant headers:
Content-Type: application/json; charset=utf-8
Body:
There are more than 1400 values in the response. Here is the beginning of the response:
{
"@odata.context": "https://selectapi.datascope.lseg.com/RestApi/v1/$metadata#ContentFieldTypes",
"value": [
{
"Code": "TNC.144A Registered Flag",
"Name": "144A Registered Flag",
"Description": "Y/N flag indicating whether the issue is registered for the 144A rule.",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "TNC.3c1 Indicator",
"Name": "3c1 Indicator",
"Description": "Securities have not been, and will not be, registered under Investment Act of 1940, as amended. Accordingly, the securities are being offered and sold only to qualified purchasers (as defined in Section 3c1 of the Investment Company Act in reliance on the exemption from the registration requirements of the Investment Act).",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "TNC.3c1 Indicator Description",
"Name": "3c1 Indicator Description",
"Description": "Description of the Rule3C1.",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "TNC.3c7 Indicator",
"Name": "3c7 Indicator",
"Description": "Securities have not been, and will not be, registered under Investment Act of 1940, as amended. Accordingly, the securities are being offered and sold only to qualified purchasers (as defined in Section 3c7 of the Investment Company Act in reliance on the exemption from the registration requirements of the Investment Act).",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "TNC.3c7 Indicator description",
"Name": "3c7 Indicator description",
"Description": "Description of the Rule3C7.",
"FormatType": "Text",
"FieldGroup": " "
},
{
"Code": "TNC.AAOIFI Compliant Flag",
"Name": "AAOIFI Compliant Flag",
"Description": "Y/N flag indicating if an Islamic financial security is compliant with the standards of the Accounting and Auditing Organization for Islamic Financial Institutions (AAOIFI).",
"FormatType": "Text",
"FieldGroup": " "
},
This goes on with all the other available fields. Here is the last part:
{
"Code": "TNC.Yield Type Description",
"Name": "Yield Type Description",
"Description": "Description of Yield Type code",
"FormatType": "Text",
"FieldGroup": "Tick History Reference"
},
{
"Code": "TNC.Yield Value",
"Name": "Yield Value",
"Description": "Value of the yield based on the income distributions in the past 12 months, as calculated by Lipper, or yield provided by the fund manager",
"FormatType": "Number",
"FieldGroup": " "
},
{
"Code": "TNC.ZPage",
"Name": "ZPage",
"Description": "Unique system-assigned four-digit alphanumeric identifier for Eurobonds",
"FormatType": "Text",
"FieldGroup": " "
}
]
}
The result contains the field code, name, a description, field type (number, text, date) and group. Use this to choose the field names you want. In the next step we will make a request for data, using some data fields we chose.
This is similar to previous tutorials, as it is also an On Demand extraction request.
The body of the request must mention it is an extraction request. It contains several parts:
Note: for all requests we need to include a user token in the header of our request. This was retrieved in Tutorial 1.
URL:
https://selectapi.datascope.lseg.com/RestApi/v1/Extractions/ExtractWithNotes
Method: POST
Headers:
Prefer: respond-async
Content-Type: application/json
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061
Body:
{
"ExtractionRequest": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.TermsAndConditionsExtractionRequest",
"ContentFieldNames": [
"RIC", "CUSIP", "ISIN", "SEDOL", "Issuer OrgID", "Currency Code"
],
"IdentifierList": {
"@odata.type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{ "Identifier": "00209tab1", "IdentifierType": "Cusip" },
{ "Identifier": "IBM.N", "IdentifierType": "Ric" },
{ "Identifier": "US4592001014", "IdentifierType": "Isin" },
{ "Identifier": "B1YW440", "IdentifierType": "Sedol" }
]
}
}
}
If the token is valid, and there is no timeout (these requests can take time as they generate very large data sets), the data will be delivered.
This is the response we get:
Status: 200 OK
Relevant headers:
Content-Type: application/json; charset=utf-8
Body:
{
"@odata.context": "https://selectapi.datascope.lseg.com/RestApi/v1/$metadata#DataScope.Select.Api.Extractions.ExtractionRequests.ExtractionResult",
"Contents": [
{
"IdentifierType": "Cusip",
"Identifier": "00209TAB1",
"RIC": "00209TAB1=RRPS",
"CUSIP": "00209TAB1",
"ISIN": "US00209TAB17",
"SEDOL": "B7SDDX3",
"Issuer OrgID": "115149232",
"Currency Code": "USD"
},
{
"IdentifierType": "Ric",
"Identifier": "IBM.N",
"RIC": "IBM.N",
"CUSIP": "459200101",
"ISIN": "US4592001014",
"SEDOL": "2005973",
"Issuer OrgID": "18228",
"Currency Code": "USD"
},
{
"IdentifierType": "Isin",
"Identifier": "US4592001014",
"RIC": "IBM.N",
"CUSIP": "459200101",
"ISIN": "US4592001014",
"SEDOL": "2005973",
"Issuer OrgID": "18228",
"Currency Code": "USD"
},
{
"IdentifierType": "Sedol",
"Identifier": "B1YW440",
"RIC": "LP71000002",
"CUSIP": null,
"ISIN": "GB00B1YW4409",
"SEDOL": "B1YW440",
"Issuer OrgID": "100691344",
"Currency Code": "GBp"
}
],
"Notes": [
"Extraction Services Version 16.0.43633 (806c08a4ae8f), Built May 9 2022 17:21:13\r\nProcessing started at 05/30/2022 08:52:29.\r\nUser ID: 9008895\r\nExtraction ID: 592935878\r\nCorrelation ID: CiD/9008895/AAAAAA.080832ffef7df0a1/RA/EXT.592935878\r\nSchedule: _OnD_0x080832ffef8df0a1 (ID = 0x080832fff18df0a1)\r\nInput List (4 items): _OnD_0x080832ffef8df0a1 (ID = 080832fff04df0a1) Created: 05/30/2022 08:52:27 Last Modified: 05/30/2022 08:52:28\r\nSchedule Time: 05/30/2022 08:52:28\r\nReport Template (12 fields): _OnD_0x080832ffef8df0a1 (ID = 0x080832ffef9df0a1) Created: 05/30/2022 08:52:27 Last Modified: 05/30/2022 08:52:27\r\nProcessing completed successfully at 05/30/2022 08:52:29, taking 0.604 Secs.\r\nExtraction finished at 05/30/2022 07:52:29 UTC, with servers: x04A05, QSDHA1 (0.0 secs), QSHC12 (0.1 secs)\r\nUsage Summary for User 9008895, Client 65508, Template Type Terms and Conditions\r\nBase Usage\r\n Instrument Instrument Terms Price\r\n Count Type Subtype Source Source\r\n------- ----------------------------------- ---------------------------- -------------- ----------------------------------------\r\n 1 Corporate Investment Grade N/A N/A\r\n 2 Equities N/A N/A\r\n 1 Mutual Funds Lipper N/A\r\n-------\r\n 4 Total instruments charged.\r\n 0 Instruments with no reported data.\r\n=======\r\n 4 Instruments in the input list.\r\nWriting RIC maintenance report.\r\n",
"Identifier,IdentType,Source,RIC,RecordDate,MaintType,OldValue,NewValue,Factor,FactorType\r\n"
]
}
If the token is valid, but there was a timeout, this is the response we get:
Status: 202 Accepted
Relevant headers:
Location: https://selectapi.datascope.lseg.com/RestApi/v1/Extractions/ExtractResult(ExtractionId='0x05a6a7961d1b3036')
Body:
Response does not contain any data.
You will have to send another HTTP GET request to retrieve the result, using the location URL that was delivered in the HTTP 202 Response header.
This is how we resend our request. Note the path, taken from the 202 response header:
URL:
https://selectapi.datascope.lseg.com/RestApi/v1/Extractions/ExtractResult(ExtractionId='0x05a6a7961d1b3036')
Method: GET
Headers:
Prefer: respond-async
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061
If the data is available, you will get the results. Otherwise, you will have to try again later. The more data is requested, the longer it can take to be available.