Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Route Unique id of the client.
    FieldGroups OrderFieldGroup [] Query-String Optional. Specification of FieldGroups to be included in response model. Defaults to "ExchangeInfo" if not provided.
    OrderId String Route Unique id of the order.
    PriceMode PriceMode Query-String Optional. Specifies the prices to be used when returning price dependent values. Default is “RegularTradingHours”.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId String The id of the account to which the net position belongs.
    AccountKey AccountKey Unique key of the account where the order is placed
    AdviceNote String Field for adviser to place relevant information.
    AlgoOrderData Dictionary Additional order data for algorithmic orders.
    AlgoStrategyName String Type of algo order strategy.
    AllocationKeyId String Allocation Key
    Amount Decimal Order size
    Ask Decimal The current market ask price.
    AssetType AssetType The instrument asset type.
    Bid Decimal The current market bid price.
    BreakoutTriggerDownPrice Decimal Used for conditional BreakoutTrigger orders. Lower trigger price. If the instrument price falls below this level, a stop loss order will be activated.
    BreakoutTriggerUpPrice Decimal Used for conditional BreakoutTrigger orders. Upper trigger price. If the instrument price exceeds this level, a take profit limit order will be activated.
    BuySell BuySell Indicates if the order is Buy Or Sell.
    CalculationReliability CalculationReliability If an error was encountered this code indicates source of the calculation error.
    CashAmount Decimal The monetary/cash purchase amount, only used when OrderAmountType is ValueInInstrumentCurrency. When set, ignore order Amount.
    ClientId String Unique identifier of the client.
    ClientKey ClientKey Unique key of the client where the order is placed
    ClientName String The name of the client.
    ClientNote String The specific text instructions for the Trading Desk to better understand IAM users intentions for staging the order.
    CopiedPositionId String The ID of the position this order was copied from
    CorrelationKey Guid Correlation key
    CorrelationTypes CorrelationType [] Type of the correlation
    CurrentPrice Decimal The user specific(delayed/realtime) current market price of the instrument.
    CurrentPriceDelayMinutes Int If set, it defines the number of minutes by which the price is delayed.
    CurrentPriceLastTraded UtcDateTime Indicates when the user specific current market price of the instrument was last traded.
    CurrentPriceType PriceType The price type (Bid/Ask/LastTraded) of the user specific(delayed/realtime) current market price of the instrument.
    DisplayAndFormat InstrumentDisplayAndFormat Information about the instrument and how to display it.
    DistanceToMarket Decimal Distance to market for this order. (Dynamically updating)
    Duration OrderDuration The time frame during which the order is valid. If the OrderDurationType is GTD, then an ExpirationDate must also be provided.
    Exchange InstrumentExchangeDetails Information about the instrument's exchange and trading status.
    ExpiryDate UtcDateTime The ExpiryDate. Valid for options and futures.
    ExternalReference String Gets or sets the Client order reference id.
    FilledAmount Decimal The amount of the order, which has already been filled, in case of partial fills.
    Greeks Greeks Greeks for option(s) i.e. FX Option, Contract Options and Contract Options CFD .
    IpoFinancingAmountPct Decimal Financing Amount Pct for IPO orders
    IpoSubscriptionFee Decimal Subscription fee for IPO orders
    IsForceOpen Bool If True, the order's resulting position will not automatically be netted with position(s) in the opposite direction
    IsMarketOpen Bool True if the instrument is currently tradable on its exchange.
    MarketPrice Decimal Current trading price of instrument. (Dynamically updating)
    MarketState MarketState Market state of exchange for instrument
    MarketValue Decimal Market value of position excl. closing costs.
    MultiLegOrderDetails MultiLegOrderDetails Common properties for multi-leg (strategy) orders.
    NonTradableReason NonTradableReasons Non tradable reason.
    OpenInterest Decimal The total number of contracts that have not been settled and remain open as of the end of a trading day.
    OpenOrderType OrderType Specifies the Order Type.
    OptionsData OrderOptionsData Details for options, warrants and structured products.
    OrderAmountType OrderAmountType Indicates if the order Amount is specified as lots/shares/contracts or as a monetary purchase amount in instrument currency.
    OrderId String Unique Id of the order.
    OrderRelation OpenOrderRelation Relation to other active orders.
    OrderTime UtcDateTime The UTC date and time the order was placed
    OwnerId String Client id of the client's owner. Only set when relevant.
    Price Decimal Price at which the order is triggered.
    RelatedOpenOrders RelatedOrderInfo [] List of information about related open orders.<br /> There should be enough information that the UI can show the price of the order, and calculate distance to market.<br />
    RelatedPositionId String Id of the related position.
    ShortTrading ShortTrading Short trading allowed or not on instrument
    SleepingOrderCondition SleepingOrderCondition Represent the condition on sleeping order.
    Status OrderStatus Current status of the order
    StopLimitPrice Decimal Secondary price level for StopLimit orders.
    SwitchInstrumentName String Name of 'SwitchInstrumentUic'/&gt;.
    SwitchInstrumentUic Int Mutual funds only. When set, instructs the order is to switch (transfer) the value of a matching open position into the specified "switch" instrument (UIC).
    ToOpenClose ToOpenClose Whether the position should be created to open/increase or close/decrease a position.
    TradeIdeaId String The ID of the TradeMaker recommendation.
    TradingStatus TradingStatus Instrument is tradable or not
    TrailingStopDistanceToMarket Decimal Distance to market for a trailing stop order.
    TrailingStopStep Decimal Step size for trailing stop order.
    TriggerParentOrderId String Order id of related conditional order that controls placement/activation of this order.
    TriggerPriceType OrderTriggerPriceType Type of price chosen to trigger a conditional order.
    Uic Int Unique Id of the instrument
    ValueDate UtcDateTime The value date (only for FxForwards).
  • Request Example

    Request URL
    GET port/v1/orders/U8SNV3JLdN4gzcQfmThXJA==/5007186409/?FieldGroups=ExchangeInfo&PriceMode=ExtendedTradingHours
  • Response Example

    Response body
    {
      "__next": "/openapi/port/....../?$top=1&$skip=1",
      "Data": [
        {
          "AccountId": "192134INET",
          "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
          "Amount": 250000.0,
          "AssetType": "FxSpot",
          "BuySell": "Buy",
          "CalculationReliability": "Ok",
          "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
          "CurrentPrice": 1.09062,
          "CurrentPriceDelayMinutes": 0,
          "CurrentPriceType": "Ask",
          "DistanceToMarket": 0.04062,
          "Duration": {
            "DurationType": "GoodTillCancel"
          },
          "IsExtendedHoursEnabled": false,
          "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,
          "PriceWithoutSpread": 1.04,
          "Status": "Working",
          "Uic": 21
        }
      ]
    }