Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount InlineCountValue Query-String Indication of whether the total count of elements must be returned.
    $skip Int Query-String Optional number of elements to skip.
    $skiptoken String Query-String Id token of entity to start taking elements from.
    $top Int Query-String Optional number of elements to retrieve.
    Arguments OpenOrdersRequest Body Arguments for the subscription request.
    ContextId String Body The streaming context id that this request is associated with. This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters.
    Format String Body Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client. Currently only application/json and application/x-protobuf is supported. If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format.
    ReferenceId String Body Mandatory client specified reference id for the subscription. This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters.
    RefreshRate Int Body Optional custom refresh rate, measured in milliseconds, between each data update. Note that it is not possible to get a refresh rate lower than the rate specified in the customer service level agreement (SLA).
    ReplaceReferenceId String Body Reference id of the subscription that should be replaced.
    Tag String Body Optional client specified tag used for grouping subscriptions.
  • Response Parameters

    View Response Codes
    Name Type Description
    ContextId String The streaming context id that this response is associated with.
    Format String The media type (RFC 2046), of the serialized data updates that are streamed to the client.
    InactivityTimeout Int The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid.
    ReferenceId String The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type)
    RefreshRate Int Actual refresh rate assigned to the subscription according to the customers SLA.
    Snapshot ListResult<OrderResponse> Snapshot of the current data on hand, when subscription was created.
    State String The value "Active".
    Tag String Client specified tag assigned to the subscription, if specified in the request.
  • Streaming Response Parameters

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

    Request URL
    POST port/v1/orders/subscriptions/?$top=99&$skip=99&$skiptoken=stringValue&$inlinecount=AllPages
    Request Body
    {
      "Arguments": {
        "AccountGroupKey": "LZTc7DdejXODf-WSl2aCyQ==",
        "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
        "ClientKey": "7m4I|vtYLUnEGg77o9uQhw=="
      },
      "ContextId": "20221126064836653",
      "Format": "application/json",
      "ReferenceId": "O82057",
      "RefreshRate": 5,
      "Tag": "PAGE1"
    }
    
  • Response Example

    Response body
    {
      "Format": "application/json",
      "InactivityTimeout": 120,
      "ReferenceId": "O82057",
      "RefreshRate": 1000,
      "Snapshot": {
        "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
          }
        ]
      },
      "State": "Active"
    }
    
  • Streaming Response Example

    Response body
    [
      {
        "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
      }
    ]