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.
    AccountGroupKey AccountGroupKey Query-String The key of the account group to which the net positions belongs.
    AccountKey AccountKey Query-String The key of the account to which the net positions belongs.
    ClientKey ClientKey Query-String The key of the client to which the net positions belongs.
    FieldGroups PositionFieldGroup [] Query-String Specifies which data to return. Default is [PositionBase,PositionView]
    NetPositionId String Query-String The id of the netposition to which the position belongs
    PositionId String Query-String The id of the position.
    WatchlistId String Query-String Selects only positions those instruments belongs to the given watchlist id

  • Response Parameters

    View Response Codes
    Name Type Description
    Costs PositionCost Trading costs associated with opening/closing a position.
    DisplayAndFormat InstrumentDisplayAndFormat Information about the position instrument and how to display it.
    Exchange InstrumentExchangeDetails Information about the instrument's exchange and trading status.
    Greeks Greeks Greeks, only available for options, i.e. FX Options, Contract Options, and Contract Options CFDs.
    NetPositionId String The id of the NetPosition, to which this position is belongs. All positions in the same instrument have the same NetPositionId.
    PositionBase PositionStatic Static part of position information.
    PositionId String Unique id of this position.
    PositionView PositionDynamic Dynamic part of position information.
    UnderlyingDisplayAndFormat InstrumentDisplayAndFormat Information about the underlying instrument of the net position and how to display it.

  • Request Example

    Request URL
    GET port/v1/positions/?$top=99&$skip=99&NetPositionId=GBPUSD_FxSpot&PositionId=1019942425&WatchlistId=stringValue&FieldGroups=UnderlyingDisplayAndFormat&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86

  • Response Example

    Response body
    {
  "__next": "/openapi/port/....../?$top=1&$skip=1",
  "Data": [
    {
      "NetPositionId": "GBPUSD_FxSpot",
      "PositionBase": {
        "AccountId": "192134INET",
        "Amount": 100000.0,
        "AssetType": "FxSpot",
        "CanBeClosed": true,
        "ClientId": "654321",
        "CloseConversionRateSettled": false,
        "ExecutionTimeOpen": "2016-09-02T10:25:00Z",
        "IsForceOpen": false,
        "IsMarketOpen": false,
        "LockedByBackOffice": false,
        "OpenPrice": 1.32167,
        "SpotDate": "2016-09-06",
        "Status": "Open",
        "Uic": 31,
        "ValueDate": "2017-05-04T00:00:00Z"
      },
      "PositionId": "1019942425",
      "PositionView": {
        "Ask": 1.2917,
        "Bid": 1.29162,
        "CalculationReliability": "Ok",
        "CurrentPrice": 1.29169,
        "CurrentPriceDelayMinutes": 0,
        "CurrentPriceType": "Bid",
        "Exposure": 100000.0,
        "ExposureCurrency": "GBP",
        "ExposureInBaseCurrency": 129192.0,
        "InstrumentPriceDayPercentChange": 0.26,
        "ProfitLossOnTrade": -2998.0,
        "ProfitLossOnTradeInBaseCurrency": -2998.0,
        "SettlementInstruction": {
          "ActualRolloverAmount": 0.0,
          "ActualSettlementAmount": 10.0,
          "Amount": 10.0,
          "IsSettlementInstructionsAllowed": false,
          "Month": 7,
          "SettlementType": "FullSettlement",
          "Year": 2020
        },
        "TradeCostsTotal": 0.0,
        "TradeCostsTotalInBaseCurrency": 0.0
      }
    }
  ]
}