Get instrument net exposure list for a client, accountGroup or account

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  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	The AssetType.
  ClientKey	ClientKey	Query-String	The key of the client to which the positions belong.
  ExpiryDate	UtcDateTime	Query-String	The expiry date. Only used to distinguish FxOptions.
  LowerBarrier	Double	Query-String	The Lower Barrier. Only used to distinguish Fx Barrier Options.
  PutCall	PutCall	Query-String	Put or Call. Only used to distinguish FxOptions.
  Strike	Double	Query-String	The strike price of the option. Only used to distinguish FxOptions.
  Uic	Int	Query-String	Unique id of the instrument.
  UpperBarrier	Double	Query-String	The Upper Barrier. Only used to distinguish Fx Barrier Options.
  ValueDate	UtcDateTime	Query-String	The value date. Only used to distinguish FxForwards.

• Response Parameters

  View Response Codes

  Name	Type	Description
  Amount	Decimal	Sum exposure of positions in instrument
  AssetType	AssetType	The AssetType.
  AverageOpenPrice	Decimal	The average price of all the positions that make up the exposure.
  CalculationReliability	CalculationReliability	If an error was encountered this code indicates source of the calculation error.
  CanBeClosed	Bool	Indicates if the exposure may be closed.
  DisplayAndFormat	InstrumentDisplayAndFormat	Information about the instrument and how to display it.
  ExpiryDate	UtcDateTime	The ExpiryDate.
  InstrumentPriceDayPercentChange	Decimal	Percent change in instrument's price between Previous Close and current Last Traded price.
  LowerBarrier	Decimal	LowerBarrier for digital option.
  NetPositionId	String	The exposure net position id. May be used to fetch the net position or open positions of the net position from the Open Positions service.
  ProfitLossOnTrade	Decimal	The P/L on the trade in the currency in which the instrument is traded.
  PutCall	PutCall	The Put/Call value of the option.
  Strike	Decimal	The strike price of the option.
  Uic	Int	Unique id of the instrument.
  UpperBarrier	Decimal	UpperBarrier for digital option.
  ValueDate	UtcDateTime	The value date. Only used to distinguish FxForwards.

  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. 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/exposure/instruments/?Uic=21&AssetType=CertificateCappedCapitalProtected&ValueDate=2021-05-21T00:00:00Z&ExpiryDate=2021-05-21T00:00:00Z&PutCall=None&Strike=2.55&UpperBarrier=2.55&LowerBarrier=2.55&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": [
      {
        "Amount": 200000.0,
        "AssetType": "FxSpot",
        "AverageOpenPrice": 1.08414,
        "CalculationReliability": "Ok",
        "CanBeClosed": false,
        "DisplayAndFormat": {
          "Currency": "USD",
          "Decimals": 4,
          "Description": "Euro/US Dollar",
          "Format": "AllowDecimalPips",
          "Symbol": "EURUSD"
        },
        "NetPositionId": "EURUSD_FxSpot",
        "Uic": 21
      }
    ]
  }