Endpoint Parameters
-
Request parameters
Name Type Origin Description $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 AccountGroupKey AccountGroupKey Query-String The key of the account group to which the order belongs. AccountKey AccountKey Query-String Unique key identifying the account that owns the orders. ClientKey ClientKey Query-String Unique key identifying the client that owns the orders. FieldGroups OrderFieldGroup [] Query-String Specifies which data to return. Default is empty, meaning Display and Formatting information is not included. OrderId String Query-String The id of the order Status OrderStatusFilter Query-String Selects only a subset of open orders to be returned. Default is to return working orders only. WatchlistId String Query-String Selects only orders those instruments belongs to the given watchlist id -
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 OrderResponse [] 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/orders?$skip=1&$top=1&AccountGroupKey=stringValue&AccountKey=01b64edf-da03-4145-bf33-ae21527d4c86&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&FieldGroups=DisplayAndFormat&OrderId=stringValue&Status=All&WatchlistId=stringValue
-
Response Example
Response body
{ "__next": "/openapi/port/....../?$top=1&$skip=1", "Data": [ { "AccountId": "192134INET", "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==", "Amount": 250000, "AssetType": "FxSpot", "BuySell": "Buy", "CalculationReliability": "Ok", "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==", "CurrentPrice": 1.09062, "CurrentPriceDelayMinutes": 0, "CurrentPriceType": "Ask", "DistanceToMarket": 0.04062, "Duration": { "DurationType": "GoodTillCancel" }, "IsForceOpen": false, "IsMarketOpen": false, "MarketPrice": 1.09062, "NonTradableReason": "None", "OpenOrderType": "Limit", "OrderAmountType": "Quantity", "OrderId": "49318458", "OrderRelation": "StandAlone", "OrderTime": "2017-04-12T07:56:00Z", "Price": 1.05, "Status": "Working", "Uic": 21 } ] }