PositionListSubscription

class saxo_openapi.endpoints.portfolio.positions.PositionListSubscription(data, params=None)

Sets up a subscription and returns an initial snapshot of list of positions specified by the parameters in the request.

ENDPOINT = 'openapi/port/v1/positions/subscriptions'
EXPECTED_STATUS = 201
METHOD = 'POST'
__init__(data, params=None)

Instantiate a PositionListSubscription request.

Parameters:
  • params (dict (optional)) – dict representing the querystring parameters
  • data (dict (required)) – dict representing the data body parameters
>>> import saxo_openapi
>>> import saxo_openapi.endpoints.portfolio as pf
>>> import json
>>> client = saxo_openapi.API(access_token=...)
>>> params =
        {}
>>> data =
        {
          "Arguments": {
            "ClientKey": "Cf4xZWiYL6W1nMKpygBLLA=="
          },
          "ContextId": "explorer_1551702571343",
          "ReferenceId": "C_702"
        }
>>> r = pf.positions.PositionListSubscription(data=data,
...                                           params=params)
>>> # without params: pf.positions.PositionListSubscription(data=data)
>>> client.request(r)
>>> print(json.dumps(r.response, indent=4))
{
  "ContextId": "explorer_1551702571343",
  "Format": "application/json",
  "InactivityTimeout": 30,
  "ReferenceId": "C_702",
  "RefreshRate": 1000,
  "Snapshot": {
    "Data": [
      {
        "NetPositionId": "EURUSD__FxSpot",
        "PositionBase": {
          "AccountId": "9226397",
          "Amount": -100000,
          "AssetType": "FxSpot",
          "CanBeClosed": true,
          "ClientId": "9226397",
          "CloseConversionRateSettled": false,
          "CorrelationKey": "46dc6b2a-5b6f-43c8-b747-6b530da9110e",
          "ExecutionTimeOpen": "2019-03-04T00:10:23.040641Z",
          "IsMarketOpen": true,
          "OpenPrice": 1.13715,
          "RelatedOpenOrders": [],
          "SourceOrderId": "76271915",
          "SpotDate": "2019-03-06",
          "Status": "Open",
          "Uic": 21,
          "ValueDate": "2019-03-06T00:00:00.000000Z"
        },
        "PositionId": "212561926",
        "PositionView": {
          "CalculationReliability": "Ok",
          "ConversionRateCurrent": 0.883135,
          "ConversionRateOpen": 0.883135,
          "CurrentPrice": 1.13243,
          "CurrentPriceDelayMinutes": 0,
          "CurrentPriceType": "Ask",
          "Exposure": -100000,
          "ExposureCurrency": "EUR",
          "ExposureInBaseCurrency": -100000,
          "InstrumentPriceDayPercentChange": -0.37,
          "ProfitLossOnTrade": 472,
          "ProfitLossOnTradeInBaseCurrency": 416.84,
          "TradeCostsTotal": -11.35,
          "TradeCostsTotalInBaseCurrency": -10.02
        }
      },
      {
        "NetPositionId": "EURUSD__FxSpot",
        "PositionBase": {
          "AccountId": "9226397",
          "Amount": 100000,
          "AssetType": "FxSpot",
          "CanBeClosed": true,
          "ClientId": "9226397",
          "CloseConversionRateSettled": false,
          "CorrelationKey": "50fae087-b7d4-49ab-afa2-5145cd56a7c5",
          "ExecutionTimeOpen": "2019-03-04T00:04:11.340151Z",
          "IsMarketOpen": true,
          "OpenPrice": 1.1371,
          "RelatedOpenOrders": [],
          "SourceOrderId": "76271912",
          "SpotDate": "2019-03-06",
          "Status": "Open",
          "Uic": 21,
          "ValueDate": "2019-03-06T00:00:00.000000Z"
        },
        "PositionId": "212561892",
        "PositionView": {
          "CalculationReliability": "Ok",
          "ConversionRateCurrent": 0.883135,
          "ConversionRateOpen": 0.883135,
          "CurrentPrice": 1.13223,
          "CurrentPriceDelayMinutes": 0,
          "CurrentPriceType": "Bid",
          "Exposure": 100000,
          "ExposureCurrency": "EUR",
          "ExposureInBaseCurrency": 100000,
          "InstrumentPriceDayPercentChange": -0.37,
          "ProfitLossOnTrade": -487,
          "ProfitLossOnTradeInBaseCurrency": -430.09,
          "TradeCostsTotal": -11.35,
          "TradeCostsTotalInBaseCurrency": -10.02
        }
      },
      {
        "NetPositionId": "GBPAUD__FxSpot",
        "PositionBase": {
          "AccountId": "9226397",
          "Amount": 500000,
          "AssetType": "FxSpot",
          "CanBeClosed": true,
          "ClientId": "9226397",
          "CloseConversionRateSettled": false,
          "CorrelationKey": "206cceed-2240-43f8-8c46-840e8b722549",
          "ExecutionTimeOpen": "2019-03-03T23:35:08.243690Z",
          "IsMarketOpen": true,
          "OpenPrice": 1.86391,
          "RelatedOpenOrders": [],
          "SourceOrderId": "76271862",
          "SpotDate": "2019-03-06",
          "Status": "Open",
          "Uic": 22,
          "ValueDate": "2019-03-06T00:00:00.000000Z"
        },
        "PositionId": "212550212",
        "PositionView": {
          "CalculationReliability": "Ok",
          "ConversionRateCurrent": 0.625415,
          "ConversionRateOpen": 0.625415,
          "CurrentPrice": 1.86215,
          "CurrentPriceDelayMinutes": 0,
          "CurrentPriceType": "Bid",
          "Exposure": 500000,
          "ExposureCurrency": "GBP",
          "ExposureInBaseCurrency": 582455,
          "InstrumentPriceDayPercentChange": -0.14,
          "ProfitLossOnTrade": -880,
          "ProfitLossOnTradeInBaseCurrency": -550.37,
          "TradeCostsTotal": -93.15,
          "TradeCostsTotalInBaseCurrency": -58.26
        }
      },
      {
        "NetPositionId": "GBPCAD__FxSpot",
        "PositionBase": {
          "AccountId": "9226397",
          "Amount": 100000,
          "AssetType": "FxSpot",
          "CanBeClosed": true,
          "ClientId": "9226397",
          "CloseConversionRateSettled": false,
          "CorrelationKey": "19c44107-6858-4191-805c-764a69d27491",
          "ExecutionTimeOpen": "2019-03-03T23:34:51.823660Z",
          "IsMarketOpen": true,
          "OpenPrice": 1.75824,
          "RelatedOpenOrders": [],
          "SourceOrderId": "76271861",
          "SpotDate": "2019-03-06",
          "Status": "Open",
          "Uic": 23,
          "ValueDate": "2019-03-06T00:00:00.000000Z"
        },
        "PositionId": "212550210",
        "PositionView": {
          "CalculationReliability": "Ok",
          "ConversionRateCurrent": 0.66362,
          "ConversionRateOpen": 0.66362,
          "CurrentPrice": 1.75496,
          "CurrentPriceDelayMinutes": 0,
          "CurrentPriceType": "Bid",
          "Exposure": 100000,
          "ExposureCurrency": "GBP",
          "ExposureInBaseCurrency": 116491,
          "InstrumentPriceDayPercentChange": -0.07,
          "ProfitLossOnTrade": -328,
          "ProfitLossOnTradeInBaseCurrency": -217.67,
          "TradeCostsTotal": -17.56,
          "TradeCostsTotalInBaseCurrency": -11.65
        }
      }
    ],
    "MaxRows": 100000
  },
  "State": "Active"
}
expected_status
response

response - get the response of the request.

status_code