Endpoint Parameters
-
Request parameters
Name Type Origin Description $inlinecount String Query-String Specifies that the response to the request should include a count of the number of entries in the collection $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 ClientKey ClientKey Query-String The client to which the accounts belong. Default: Logged-in user's client. IncludeSubAccounts Boolean Query-String Optionally set true to request that all sub accounts are returned. -
Response Parameters
View Response CodesName 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 AccountResponse [] 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/accounts?$inlinecount=AllPages&$skip=1&$top=1&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&IncludeSubAccounts=True
-
Response Example
Response body
{ "__next": "/openapi/port/....../?$top=1&$skip=1", "Data": [ { "AccountGroupKey": "LZTc7DdejXODf-WSl2aCyQ==", "AccountId": "192134INET", "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==", "AccountType": "Normal", "Active": true, "CanUseCashPositionsAsMarginCollateral": false, "CfdBorrowingCostsActive": false, "ClientId": "654321", "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==", "CreationDate": "2017-01-01T13:00:00Z", "Currency": "EUR", "CurrencyDecimals": 2, "DirectMarketAccess": false, "FractionalOrderEnabled": false, "IndividualMargining": false, "IsCurrencyConversionAtSettlementTime": false, "IsMarginTradingAllowed": true, "IsShareable": true, "IsTrialAccount": false, "LegalAssetTypes": [ "FxSpot", "Stock", "ContractFutures" ], "ManagementType": "Client", "MarginCalculationMethod": "Default", "MarginLendingEnabled": "None", "PortfolioBasedMarginEnabled": false, "Sharing": [ "TradingFloor" ], "SupportsAccountValueProtectionLimit": false, "UseCashPositionsAsMarginCollateral": false } ] }