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	Number	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	Number	Query-String	The strike price of the option. Only used to distinguish FxOptions.
  Uic	Integer	Query-String	Unique id of the instrument.
  UpperBarrier	Number	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
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	InstrumentExposureResponse []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  200	OK	OK
  204	No Content	No Content
  400	Bad Request	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.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /port/v1/exposure/instruments?AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&AssetType=CfdOnFutures&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&ExpiryDate=2021-05-21&LowerBarrier=2.55&PutCall=Call&Strike=2.55&Uic=99&UpperBarrier=2.55&ValueDate=2021-05-21

• Response Example

  Response body

  {
    "__next": "/openapi/port/....../?$top=1&$skip=1",
    "Data": [
      {
        "Amount": 200000,
        "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
      }
    ]
  }