Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Int Query-String Optional number of elements to skip.
    $top Int Query-String Optional number of elements to retrieve.
    AccountKey AccountKey Query-String If specified, access permissions to instruments for the specified account will be evaluated. Optional.
    AssetTypes AssetType [] Query-String Comma separated list of one or more asset types to search for. E.g. AssetTypes=FxSpot,Stock
    CanParticipateInMultiLegOrder Bool Query-String Should the result only include option roots that allow/disallow exchange traded option strategies, also know as multi-leg or combination orders. All roots are returned regardless if omitted.
    Class Class [] Query-String The class of the instruments to include in the search.
    ExchangeId String Query-String ID of the exchange that the instruments must match.
    IncludeNonTradable Bool Query-String Should the search include instruments, which are not online client tradable?
    Keywords String Query-String Search for matching keywords in the instruments. Separate keywords with spaces.
    OneMonthTotalValueChangesFrom Decimal Query-String Subject to data license agreements.<br /> Upper filter boundary for one month total value changes that the instruments must match.
    OneMonthTotalValueChangesTo Decimal Query-String Subject to data license agreements.<br /> Lower filter boundary for one month total value changes that the instruments must match.
    OneWeekTotalValueChangesFrom Decimal Query-String Subject to data license agreements.<br /> Upper filter boundary for one week total value changes that the instruments must match.
    OneWeekTotalValueChangesTo Decimal Query-String Subject to data license agreements.<br /> Lower filter boundary for one week total value changes that the instruments must match.
    OneYearTotalValueChangesFrom Decimal Query-String Subject to data license agreements.<br /> Upper filter boundary for one year total value changes that the instruments must match.
    OneYearTotalValueChangesTo Decimal Query-String Subject to data license agreements.<br /> Lower filter boundary for one year total value changes that the instruments must match.
    Tags String [] Query-String Allows filtering by display hint, on Stocks, ETFs and ETCs are currently supported. Use <value>null</value> to indicate Tag should not be included in search criteria. Currently only one tag is supported.
    Uics Int [] Query-String Limit list to return information for the following Uics

  • Response Parameters

    View Response Codes
    Name Type Description
    AssetType AssetType AssetType (Note: OptionRoots also have an asset type (FuturesOption, StockOption, StockIndexOption).
    CanParticipateInMultiLegOrder Bool Only for ContractOption roots. True if this root supports exchange traded option strategies, also know as multi-leg or combination orders.
    CurrencyCode String The ISO currency code of the instrument/symbol.
    Description String Description of Instrument (DAX Index - Nov 2013), in English.
    DisplayHint DisplayHintType Hint to the client application about how it should display the instrument.
    ExchangeCountry String Country of the exchange where the instrument is traded.
    ExchangeId String The Id of the exchange where this instrument or the underlying instrument is traded. For most instruments this is the exchange where this instrument is traded. For CFDs on stocks and futures, it is the exchange where the underlying instrument is traded. For CFDs on stock indices, it is the exchange of the underlying ticker.
    ExchangeName String Name of the exchange where this instrument or the underlying instrument is traded. See ExchangeId for further information.
    GroupId Int The GroupId value is used to group and structure instruments list. 0 is being used for ungrouped data.
    Identifier Int Uic - If this is an instrument <br /> ContractOptionRootId - if this is an option root.
    IsKeywordMatch Bool Indicates that this summary was found as a result of a keyword match.
    PrimaryListing Int The uic of the primary listing of this instrument. For stocks and CFDs, this is the instrument traded on the exchange of the same country as issuer country. For expiring instruments, this is the next expiring instance.
    SummaryType EntityType Type of the summary.
    Symbol String Symbol- A combination of letters used to uniquely identify a traded instrument. e.g. ODAX/X13C8950:xeur or EURUSD.
    TradableAs AssetType [] For instruments: How can an instrument with "this" uic also be traded.
    UnderlyingAssetType AssetType The asset type of the underlying instrument.

  • Request Example

    Request URL
    GET ref/v1/instruments/?$top=99&$skip=99&ExchangeId=NYMEX&Keywords=Oil&IncludeNonTradable=False&Class=[ "NonComplex" ]&CanParticipateInMultiLegOrder=false&Uics=[ 99 ]&OneYearTotalValueChangesFrom=10.0&OneYearTotalValueChangesTo=10.0&OneMonthTotalValueChangesFrom=10.0&OneMonthTotalValueChangesTo=10.0&OneWeekTotalValueChangesFrom=10.0&OneWeekTotalValueChangesTo=10.0&AssetTypes=[ "CompanyWarrant" ]&Tags=[ "stringValue" ]&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86

  • Response Example

    Response body
    {
  "__next": "/openapi/....../?$top=1&$skip=1",
  "Data": [
    {
      "AssetType": "CfdOnFutures",
      "Description": "US Crude June 2017",
      "ExchangeId": "",
      "GroupId": 0,
      "Identifier": 6456061,
      "IsKeywordMatch": true,
      "PrimaryListing": 6456061,
      "SummaryType": "Instrument",
      "Symbol": "OILUSJUN17",
      "TradableAs": [
        "CfdOnFutures"
      ]
    },
    {
      "AssetType": "CfdOnFutures",
      "Description": "US Crude July 2017",
      "ExchangeId": "",
      "GroupId": 0,
      "Identifier": 6665418,
      "IsKeywordMatch": true,
      "PrimaryListing": 6456061,
      "SummaryType": "Instrument",
      "Symbol": "OILUSJUL17",
      "TradableAs": [
        "CfdOnFutures"
      ]
    },
    {
      "AssetType": "CfdOnFutures",
      "Description": "Heating Oil June 2017",
      "ExchangeId": "",
      "GroupId": 0,
      "Identifier": 6559778,
      "IsKeywordMatch": true,
      "PrimaryListing": 6559778,
      "SummaryType": "Instrument",
      "Symbol": "HEATINGOILJUN17",
      "TradableAs": [
        "CfdOnFutures"
      ]
    }
  ]
}