DataScope Select - REST API

Close Menu
Expand All Collapse All
Introductory Tutorials Tutorials Introduction Programming without SDK Tutorial REST API Tutorials REST API Tutorials Introduction REST API Tutorial 1: Connecting to the DSS server REST API Tutorial 2: On Demand End of Day Extraction REST API Tutorial 3: On Demand intraday extraction, embargo REST API Tutorial 4: On Demand price history extraction REST API Tutorial 5: On Demand corporate actions extraction REST API Tutorial 6: On Demand ownership data extraction REST API Tutorial 7: On Demand T&C extraction REST API Tutorial 8: On Demand composite extraction REST API Tutorial 9: On Demand extraction: instrument list REST API Tutorial 10: GUI control calls: immediate extract REST API Tutorial 11: Search by Instrument REST API Tutorial 12: Search for an Equity REST API Tutorial 13: Search for a Future or Option REST API Tutorial 14: On Demand price history extraction raw .Net SDK Tutorials .Net SDK Tutorial 1: Connecting to the DSS server .Net SDK Tutorial 2: GUI control calls: List, report, sched .Net SDK Tutorial 3: GUI control calls: Validate, extraction .Net SDK Tutorial 4: GUI control calls: Embargo, note files .Net SDK Tutorial 5: On Demand: EoD extraction .Net SDK Tutorial 6: On Demand: EoD extraction, file I/O .Net SDK Tutorial 7: On Demand: large instrument lists .Net SDK Tutorial 8: On Demand: Terms & Conditions .Net SDK Tutorial 9: On Demand: Composite extraction .Net SDK Tutorial 10: Search by Instrument .Net SDK Tutorial 11: Search for Equity .Net SDK Tutorial 12: Search for Future or Option

REST API Tutorial 12: Search for an Equity

Last update July 2019
Environment Any
Language Any HTTP is supported
Compilers None
Prerequisites DSS login, internet access
Source code Below

Tutorial purpose

This tutorial explains how to make a search request for an equity, using as criteria the exchange and the ticker (other criteria are also available).

 

Table of contents

 

Equity search by exchange and ticker - HTTP request

Note:

  • For all requests we need to include a user token in the header of our request. This was retrieved in Tutorial 1.

The body of the request contains the list of available search criteria:

  • In this example we search for active instruments, using a list of exchange codes and a ticker.
  • Other combinations are of course possible. See the REST API Reference Tree for more information on the search criteria.

The following request searches for all valid instruments corresponding to a specific ticker, on two specific exchanges.

URL:               

https://hosted.datascopeapi.reuters.com/RestApi/v1/Search/EquitySearch

Method:          POST

Headers:

Prefer: respond-async
Content-Type: application/json
Authorization: Token F0ABE9A3FFF2E02E10AE2765ED872C59B8CC3B40EBB61B30E295E71DE31C254B8648DB9434C2DF9299FDC668AA123501F322D99D45C8B93438063C912BC936C7B87062B0CF812138863F5D836A7B31A32DCA67EF07B3B50B2FC4978DF6F76784FDF35FCB523A8430DA93613BC5730CDC310D4D241718F9FC3F2E55465A24957CC287BDEC79046B31AD642606275AEAD76318CB221BD843348E1483670DA13968D8A242AAFCF9E13E23240C905AE46DED9EDCA9BB316B4C5C767B18DB2EA7ADD100817ADF059D01394BC6375BECAF6138C25DBA57577F0061

Body:

{
    "SearchRequest": {
        "AssetStatus": "Active",
        "AssetCategoryCodes": null,
        "SubTypeCodes": null,
        "CurrencyCodes": null,
        "CompanyName": null,
        "Description": null,
        "DomicileCodes": null,
        "ExchangeCodes": [ "PAR", "SWX" ],
        "FairValueIndicator": null,
        "FileCodes": null,
        "GicsCodes": null,
        "OrgId": null,
        "Ticker": "UG",
        "Identifier": null,
        "IdentifierType": null,
        "PreferredIdentifierType": null
    }
}

 

Equity search by exchange and ticker - HTTP response

Status:                        200 OK

Relevant headers:

Content-Type: application/json; charset=utf-8

Body:

{
  "@odata.context": "https://hosted.datascopeapi.reuters.com/RestApi/v1/$metadata#Collection(ThomsonReuters.Dss.Api.Search.EquitySearchResult)",
  "value": [
    {
      "Identifier": "PEUP.PA",
      "IdentifierType": "Ric",
      "Source": "PAR",
      "Key": "VjF8MHgwMDAzZGQwMDE0Yjg1YTI4fDB4MDAwM2RjMDA0YzI1NGRmYnxQQVJ8RVFRVXxFUVRZfE9EU0h8RXx8UEVVUC5QQXwwMDUy",
      "Description": "PEUGEOT ORD",
      "InstrumentType": "EquityQuote",
      "Status": "Valid",
      "DomicileCode": "FR",
      "CurrencyCodes": "EUR",
      "SubTypeCode": "ODSH",
      "AssetStatus": "Active",
      "IssuerName": "PEUGEOT",
      "IssuerOrgId": "11864",
      "Exchange": "PAR",
      "FileCode": "52"
    },
    {
      "Identifier": "PEUP.S",
      "IdentifierType": "Ric",
      "Source": "SWX",
      "Key": "VjF8MHgwMDAzZGQwMDE0Yjg1YTI4fDB4MDAxMDBiMDAwYjU2OTJmZnxTV1h8RVFRVXxFUVRZfE9EU0h8RXx8UEVVUC5TfDA0Nzc",
      "Description": "PEUGEOT ORD",
      "InstrumentType": "EquityQuote",
      "Status": "Valid",
      "DomicileCode": "FR",
      "CurrencyCodes": "CHF",
      "SubTypeCode": "ODSH",
      "AssetStatus": "Active",
      "IssuerName": "PEUGEOT",
      "IssuerOrgId": "11864",
      "Exchange": "SWX",
      "FileCode": "477"
    }
  ]
}

 

Tutorial Group: 
REST API Tutorials