InstrumentsDetails

class saxo_openapi.endpoints.referencedata.instruments.InstrumentsDetails(params)

Get detailed information on a list of instruments.

ENDPOINT = 'openapi/ref/v1/instruments/details'

EXPECTED_STATUS = 200

METHOD = 'GET'

__init__(params)

Instantiate an InstrumentsDetails request.

Parameters:params (dict (required)) – dict reppresenting the querystring parameters

>>> import json
>>> import saxo_openapi
>>> import saxo_openapi.endpoints.referencedata as rd
>>> client = saxo_openapi.API(access_token=...)
>>> params =
        {
          "AccountKey": "Cf4xZWiYL6W1nMKpygBLLA==",
          "Uics": "23"
        }

>>> r = rd.instruments.InstrumentsDetails(params=params)
>>> client.request(r)
>>> print(json.dumps(r.response, indent=4))

Output:

{
  "__count": 6,
  "Data": [
    {
      "AmountDecimals": 6,
      "AssetType": "FxSwap",
      "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": "AllowTwoDecimalPips",
        "OrderDecimals": 4
      },
      "FxForwardMaxForwardDate": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "FxSpotDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 5000,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OrderDistances": {
        "EntryDefaultDistance": 0.5,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 50,
        "StopLossDefaultDistanceType": "Pips",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 50,
        "TakeProfitDefaultDistanceType": "Pips",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        50000,
        100000,
        250000,
        500000,
        1000000,
        2000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 0.0001,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [],
      "TradingSignals": "NotAllowed",
      "Uic": 23
    },
    {
      "AmountDecimals": 6,
      "AssetType": "FxKnockOutOption",
      "CurrencyCode": "CAD",
      "DefaultAmount": 100,
      "Description": "British Pound/Canadian Dollar",
      "Exchange": {
        "CountryCode": "DK",
        "ExchangeId": "SBFX",
        "Name": "Inter Bank"
      },
      "Format": {
        "Decimals": 4,
        "OrderDecimals": 4,
        "StrikeDecimals": 4
      },
      "FxForwardMaxForwardDate": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 100,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OptionsChainSubscriptionAllowed": true,
      "OrderDistances": {
        "EntryDefaultDistance": 0.25,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 0.5,
        "StopLossDefaultDistanceType": "Percentage",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 0.5,
        "TakeProfitDefaultDistanceType": "Percentage",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        30000,
        50000,
        80000,
        100000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 0.0001,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "9226397"
      ],
      "TradingSignals": "NotAllowed",
      "Uic": 23
    },
    {
      "AmountDecimals": 6,
      "AssetType": "FxKnockInOption",
      "CurrencyCode": "CAD",
      "DefaultAmount": 100,
      "Description": "British Pound/Canadian Dollar",
      "Exchange": {
        "CountryCode": "DK",
        "ExchangeId": "SBFX",
        "Name": "Inter Bank"
      },
      "Format": {
        "Decimals": 4,
        "OrderDecimals": 4,
        "StrikeDecimals": 4
      },
      "FxForwardMaxForwardDate": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 100,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OptionsChainSubscriptionAllowed": true,
      "OrderDistances": {
        "EntryDefaultDistance": 0.25,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 0.5,
        "StopLossDefaultDistanceType": "Percentage",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 0.5,
        "TakeProfitDefaultDistanceType": "Percentage",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        30000,
        50000,
        80000,
        100000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 0.0001,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "9226397"
      ],
      "TradingSignals": "NotAllowed",
      "Uic": 23
    },
    {
      "AmountDecimals": 6,
      "AssetType": "FxVanillaOption",
      "CurrencyCode": "CAD",
      "DefaultAmount": 100000,
      "Description": "British Pound/Canadian Dollar",
      "Exchange": {
        "CountryCode": "DK",
        "ExchangeId": "SBFX",
        "Name": "Inter Bank"
      },
      "Format": {
        "Decimals": 4,
        "Format": "AllowDecimalPips",
        "StrikeDecimals": 4
      },
      "FxForwardMaxForwardDate": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 10000,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OptionsChainSubscriptionAllowed": true,
      "OrderDistances": {
        "EntryDefaultDistance": 0.5,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 50,
        "StopLossDefaultDistanceType": "Pips",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 50,
        "TakeProfitDefaultDistanceType": "Pips",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        100000,
        250000,
        500000,
        1000000,
        2000000,
        3000000,
        4000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 0.0005,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "9226397"
      ],
      "TradingSignals": "NotAllowed",
      "Uic": 23
    },
    {
      "AmountDecimals": 6,
      "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": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "FxSpotDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 5000,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OrderDistances": {
        "EntryDefaultDistance": 0.5,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 50,
        "StopLossDefaultDistanceType": "Pips",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 50,
        "TakeProfitDefaultDistanceType": "Pips",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        50000,
        100000,
        250000,
        500000,
        1000000,
        2000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 5e-05,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "9226397"
      ],
      "TradingSignals": "Allowed",
      "Uic": 23
    },
    {
      "AmountDecimals": 6,
      "AssetType": "FxForwards",
      "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": "2020-03-10T00:00:00.000000Z",
      "FxForwardMinForwardDate": "2019-03-06T00:00:00.000000Z",
      "FxSpotDate": "2019-03-06T00:00:00.000000Z",
      "GroupId": 0,
      "IncrementSize": 5000,
      "IsTradable": true,
      "MinimumTradeSize": 1000,
      "OrderDistances": {
        "EntryDefaultDistance": 0.5,
        "EntryDefaultDistanceType": "Percentage",
        "StopLimitDefaultDistance": 5,
        "StopLimitDefaultDistanceType": "Pips",
        "StopLossDefaultDistance": 50,
        "StopLossDefaultDistanceType": "Pips",
        "StopLossDefaultEnabled": false,
        "StopLossDefaultOrderType": "Stop",
        "TakeProfitDefaultDistance": 50,
        "TakeProfitDefaultDistanceType": "Pips",
        "TakeProfitDefaultEnabled": false
      },
      "StandardAmounts": [
        10000,
        50000,
        100000,
        250000,
        500000,
        1000000,
        2000000,
        5000000,
        10000000,
        20000000
      ],
      "SupportedOrderTypes": [
        "Market",
        "Limit",
        "Stop",
        "TrailingStop",
        "StopLimit"
      ],
      "Symbol": "GBPCAD",
      "TickSize": 0.0001,
      "TickSizeLimitOrder": 0.0001,
      "TickSizeStopOrder": 5e-05,
      "TradableAs": [
        "FxSpot",
        "FxForwards",
        "FxVanillaOption",
        "FxKnockInOption",
        "FxKnockOutOption"
      ],
      "TradableOn": [
        "9226397"
      ],
      "TradingSignals": "NotAllowed",
      "Uic": 23
    }
  ]
}

expected_status

response

response - get the response of the request.

status_code