Get net positions for a client, account group or account

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 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	Double	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	Double	Query-String	Optional. The strike price of the option. Only used to distinguish FxOptions.
  Uic	Int	Query-String	Optional. Unique id of the instrument.
  UpperBarrier	Double	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
  DisplayAndFormat	InstrumentDisplayAndFormat	[Community] Information about the instrument of the net position and how to display it.
  Exchange	InstrumentExchangeDetails	Information about the exchange where this instrument or the underlying instrument is traded.
  Greeks	Greeks	Greeks for option(s) i.e. FX Option, Contract Options and Contract Options CFD .
  NetPositionBase	NetPositionStatic	Static part of net position information
  NetPositionId	String	[Community] The id of the net position. This can be used to fetch the open positions of a net position from the Positions service.
  NetPositionView	NetPositionDynamic	Dynamic part of net position information.
  UnderlyingDisplayAndFormat	InstrumentDisplayAndFormat	Information about the underlying instrument of the net position and how to display it.

  HTTP Code	Description
  200	OK	OK
  204	NoContent	Error Code Description NoContent Indicates no information about the exchange is available with the service.
  400	BadRequest	Error Code Description InvalidClientId Indicates that the requested client id was invalid. InvalidExchangeId The provided exchange id is invalid. NetPositionIdNotSpecified Net position not specified. NoValidInput No valid input values passed. InvalidRequest Indicates that the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  503	ServiceUnavailable	Service Unavailable

  Close

• Request Example

  Request URL

  GET port/v1/netpositions/?$top=99&$skip=99&NetPositionId=EURUSD 41761NY 1.3765 C&Uic=99&AssetType=GuaranteeNote&ValueDate=2021-05-21T00:00:00Z&ExpiryDate=2021-05-21T00:00:00Z&PutCall=Put&Strike=2.55&UpperBarrier=2.55&LowerBarrier=2.55&WatchlistId=stringValue&FieldGroups=DisplayAndFormat&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": [
      {
        "NetPositionBase": {
          "AccountId": "192134INET",
          "Amount": 100000.0,
          "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.0,
          "ExposureInBaseCurrency": 129205.0,
          "InstrumentPriceDayPercentChange": 0.27,
          "PositionCount": 1,
          "PositionsNotClosedCount": 0,
          "ProfitLossOnTrade": -2979.0,
          "Status": "Open",
          "TradeCostsTotal": 0.0,
          "TradeCostsTotalInBaseCurrency": 0.0
        }
      }
    ]
  }