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 resource belongs. AccountKey AccountKey Query-String The key of the account to which the resource belongs. ClientKey ClientKey Route The key of the client to which the resource belongs. FromDate Date Route From date ToDate Date Route To date -
Response Parameters
View Response CodesName Type Description AccountCurrency String The account currency AccountCurrencyDecimals Int The amount of decimals used by the account currency AccountId String AccountId Amount Decimal The amount bought or sold AmountClose Decimal The total traded amount for the Closing trade AmountOpen Decimal The total traded amount for the opening trade AssetType AssetType AssetType ClientCurrency String Client Currency CloseIndexRatio Decimal Close Index Ratio ClosePositionId String Close position Id ClosePrice Decimal Close price of position ExchangeDescription String Description of exchange InstrumentCurrency String Instrument Currency InstrumentDescription String Instrument InstrumentSectorName String Sector name of the instrument InstrumentSectorTypeId Int Sector type Id of instrument InstrumentSymbol String The instrument code OpenIndexRatio Decimal Open Index Ratio OpenPositionId String Open position Id OpenPrice Decimal Open price of position PnLAccountCurrency Decimal Profit and Loss in account currency PnLClientCurrency Decimal Profit and Loss in client currency PnLUSD Decimal Profit and Loss in USD RootInstrumentSectorName String Top Level Sector name of the instrument RootInstrumentSectorTypeId Int Top Level Sector Id of the instrument TotalBookedOnClosingLegAccountCurrency Decimal Total booked on closing leg in account currency TotalBookedOnClosingLegClientCurrency Decimal Total booked on closing in client currency TotalBookedOnClosingLegUSD Decimal Total booked on closing in USD TotalBookedOnOpeningLegAccountCurrency Decimal Total booked on opening leg in account currency TotalBookedOnOpeningLegClientCurrency Decimal Total booked on opening leg in client currency TotalBookedOnOpeningLegUSD Decimal Total booked on opening leg in USD TradeDate Date Date of Trade TradeDateClose Date Tradedate for closing trade TradeDateOpen Date Tradedate for opening trade UnderlyingInstrumentDescription String Description of underlying instrument UnderlyingInstrumentSymbol String Symbol of underlying instrument -
Request Example
Request URL
GET cs/v1/reports/closedPositions/493b43a5-fe85-4d1f-9071-dd4a9d4e42a4/2016-10-10/2017-10-10/?$top=99&$skip=99&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86
-
Response Example
Response body
{ "__next": "/openapi/....../?$top=1&$skip=1", "Data": [ { "AccountCurrency": "USD", "AccountCurrencyDecimals": 2, "AccountId": "169236INET2", "Amount": 400.0, "AmountClose": -700.0, "AmountOpen": 400.0, "AssetType": "Stock", "ClosePositionId": "112428055", "ClosePrice": 3.1, "CloseType": "Buy", "ExchangeDescription": "NASDAQ", "InstrumentDescription": "Central European Media Enterprise Ltd", "InstrumentSectorName": "Broadcasting & Entertainment", "InstrumentSectorTypeId": 640, "InstrumentSymbol": "CETV:xnas", "OpenPositionId": "642405794", "OpenPrice": 3.6126, "PnLAccountCurrency": 228.64, "PnLClientCurrency": 2614.90455108964, "PnLUSD": -228.64, "RootInstrumentSectorName": "Consumer Service", "RootInstrumentSectorTypeId": 506, "TotalBookedOnClosingLegAccountCurrency": 2154.95, "TotalBookedOnClosingLegClientCurrency": 54083.2750759607, "TotalBookedOnClosingLegUSD": 2154.95, "TotalBookedOnOpeningLegAccountCurrency": -1460.04, "TotalBookedOnOpeningLegClientCurrency": -28289.824063745, "TotalBookedOnOpeningLegUSD": -1406.04, "TradeDate": "2017-04-07", "TradeDateClose": "2017-04-07", "TradeDateOpen": "2013-08-19", "UnderlyingInstrumentDescription": "Central European Media Enterprise Ltd", "UnderlyingInstrumentSymbol": "CETV:xnas" } ] }