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 NetPositionFieldGroup [] Query-String Specifies which data to return. Default is [NetPositionBase, NetPositionView].
  • 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 NetPositionResponse [] 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/netpositions/me?$skip=1&$top=1&FieldGroups=DisplayAndFormat
  • Response Example

    Response body
    {
      "__next": "/openapi/port/....../?$top=1&$skip=1",
      "Data": [
        {
          "NetPositionBase": {
            "AccountId": "192134INET",
            "Amount": 100000,
            "AssetType": "FxSpot",
            "CanBeClosed": true,
            "ClientId": "654321",
            "HasForceOpenPositions": false,
            "IsMarketOpen": false,
            "NonTradableReason": "None",
            "NumberOfRelatedOrders": 0,
            "OpeningDirection": "Buy",
            "OpenIpoOrdersCount": 0,
            "OpenOrdersCount": 0,
            "OpenTriggerOrdersCount": 0,
            "PositionsAccount": "192134INET",
            "SinglePositionStatus": "Open",
            "Uic": 31,
            "ValueDate": "2017-05-04T00:00:00Z"
          },
          "NetPositionId": "GPBUSD_FXSpot",
          "NetPositionView": {
            "AverageOpenPrice": 1.32167,
            "AverageOpenPriceIncludingCosts": 1.32172,
            "CalculationReliability": "Ok",
            "CurrentPrice": 1.29188,
            "CurrentPriceDelayMinutes": 15,
            "CurrentPriceType": "Mid",
            "Exposure": 100000,
            "ExposureInBaseCurrency": 129205,
            "InstrumentPriceDayPercentChange": 0.27,
            "PositionCount": 1,
            "PositionsNotClosedCount": 0,
            "ProfitLossOnTrade": -2979,
            "Status": "Open",
            "TradeCostsTotal": 0,
            "TradeCostsTotalInBaseCurrency": 0
          }
        }
      ]
    }