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
    FieldGroups PositionFieldGroup [] Query-String Optional. Specifies which data to return. Default is [PositionBase, PositionView]
  • 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 PositionResponse [] 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 /port/v1/positions/me?$skip=1&$top=1&FieldGroups=DisplayAndFormat
  • Response Example

    Response body
    {
      "__next": "/openapi/port/....../?$top=1&$skip=1",
      "Data": [
        {
          "NetPositionId": "GBPUSD_FxSpot",
          "PositionBase": {
            "AccountId": "192134INET",
            "Amount": 100000,
            "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-06T00:00:00Z",
            "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,
            "ExposureCurrency": "GBP",
            "ExposureInBaseCurrency": 129192,
            "InstrumentPriceDayPercentChange": 0.26,
            "ProfitLossOnTrade": -2998,
            "ProfitLossOnTradeInBaseCurrency": -2998,
            "SettlementInstruction": {
              "ActualRolloverAmount": 0,
              "ActualSettlementAmount": 10,
              "Amount": 10,
              "IsSettlementInstructionsAllowed": false,
              "Month": 7,
              "SettlementType": "FullSettlement",
              "Year": 2020
            },
            "TradeCostsTotal": 0,
            "TradeCostsTotalInBaseCurrency": 0
          }
        }
      ]
    }