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
    AccountGroupKey AccountGroupKey Query-String The key of the account group to which the positions belong.
    AccountKey AccountKey Query-String The key of the account to which the positions belong.
    AssetType AssetType Query-String Optional. The AssetType.
    ClientKey ClientKey Query-String The key of the client to which the positions belong.
    ExpiryDate UtcDateTime Query-String Optional. The expiry date. Only used to distinguish FxOptions.
    FieldGroups NetPositionFieldGroup [] Query-String Specifies which data to return. Default is [NetPositionBase,NetPositionView]
    LowerBarrier Number Query-String Optional. The Lower Barrier. Only used to distinguish Fx Barrier Options.
    NetPositionId String Query-String Optional. The id of the netposition
    PutCall PutCall Query-String Optional. Put or Call. Only used to distinguish FxOptions.
    Strike Number Query-String Optional. The strike price of the option. Only used to distinguish FxOptions.
    Uic Integer Query-String Optional. Unique id of the instrument.
    UpperBarrier Number Query-String Optional. The Upper Barrier. Only used to distinguish Fx Barrier Options.
    ValueDate UtcDateTime Query-String Optional. The value date. Only used to distinguish FxForwards.
    WatchlistId String Query-String Optional. Watchlist Id.Filter on watchlist instruments

  • 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?$skip=1&$top=1&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&AssetType=MutualFund&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&ExpiryDate=2021-05-21&FieldGroups=DisplayAndFormat&LowerBarrier=2.55&NetPositionId=stringValue&PutCall=Put&Strike=2.55&Uic=99&UpperBarrier=2.55&ValueDate=2021-05-21&WatchlistId=stringValue

  • 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
      }
    }
  ]
}