Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $skip Integer Query-String The number of entries to skip from the beginning of the collection
    $top Integer Query-String The number of entries to return from the beginning of the collection
    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
    FieldGroups InstrumentFieldGroup [] Query-String Specifies comma-separated list of additional fields to receive.
    Tags String [] Query-String Allows filtering by display hint, on Stocks, ETFs and ETCs are currently supported. Use null to indicate Tag should not be included in search criteria. Currently only one tag is supported.
    Uics Integer [] Query-String Limit list to return information for the following Uics

  • Response Parameters

    View Response Codes
    Name Type Description
    __count Number The total count of items in the feed.
    __next String The link for the next page of items in the feed.
    Data InstrumentDetails [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).

  • Request Example

    Request URL
    GET /ref/v1/instruments/details?$skip=1&$top=1&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&AssetTypes=CertificateUncappedCapitalProtection&FieldGroups=AnalystConsensus&Tags={Tags}&Uics={Uics}

  • Response Example

    Response body
    {
  "__next": "/openapi/....../?$top=1&$skip=1",
  "Data": [
    {
      "AmountDecimals": 0,
      "AssetType": "FxSpot",
      "CurrencyCode": "AUD",
      "DefaultAmount": 100000,
      "DefaultSlippage": 0.01,
      "DefaultSlippageType": "Percentage",
      "Description": "British Pound/Australian Dollar",
      "Exchange": {
        "CountryCode": "DK",
        "ExchangeId": "SBFX",
        "Name": "Inter Bank"
      },
      "Format": {
        "Decimals": 4,
        "Format": "AllowDecimalPips",
        "OrderDecimals": 4
      },
      "FxForwardMaxForwardDate": "2018-05-08T00:00:00Z",
      "FxForwardMinForwardDate": "2017-05-03T00:00:00Z",
      "GroupId": 0,
      "IncrementSize": 5000,
      "IsRedemptionByAmounts": false,
      "IsTradable": true,
      "NonTradableReason": "None",
      "OrderDistances": {
        "EntryDefaultDistance": 0,
        "EntryDefaultDistanceType": "Percentage",
        "LimitDefaultDistance": 0,
        "LimitDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 0.5,
        "StopLossDefaultDistanceType": "Percentage",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 0.5,
        "TakeProfitDefaultDistanceType": "Percentage",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        50000,
        100000,
        250000,
        500000,
        1000000,
        2000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPAUD",
      "TickSize": 5E-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "76940INET",
        "76940INET1",
        "76940INET2",
        "SAMGS*585220"
      ],
      "TradingStatus": "NotDefined",
      "Uic": 22
    },
    {
      "AmountDecimals": 0,
      "AssetType": "FxSpot",
      "CurrencyCode": "CAD",
      "DefaultAmount": 100000,
      "DefaultSlippage": 0.01,
      "DefaultSlippageType": "Percentage",
      "Description": "British Pound/Canadian Dollar",
      "Exchange": {
        "CountryCode": "DK",
        "ExchangeId": "SBFX",
        "Name": "Inter Bank"
      },
      "Format": {
        "Decimals": 4,
        "Format": "AllowDecimalPips",
        "OrderDecimals": 4
      },
      "FxForwardMaxForwardDate": "2018-05-07T00:00:00Z",
      "FxForwardMinForwardDate": "2017-05-02T00:00:00Z",
      "GroupId": 0,
      "IncrementSize": 5000,
      "IsRedemptionByAmounts": false,
      "IsTradable": true,
      "NonTradableReason": "None",
      "OrderDistances": {
        "EntryDefaultDistance": 0,
        "EntryDefaultDistanceType": "Percentage",
        "LimitDefaultDistance": 0,
        "LimitDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 0.5,
        "StopLossDefaultDistanceType": "Percentage",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 0.5,
        "TakeProfitDefaultDistanceType": "Percentage",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        50000,
        100000,
        250000,
        500000,
        1000000,
        2000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 5E-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "76940INET",
        "76940INET1",
        "76940INET2",
        "SAMGS*585220"
      ],
      "TradingStatus": "NotDefined",
      "Uic": 23
    }
  ]
}