API documentation

Client → serverAuthentication: Required

SendOrder()

Parameters

Required

Request payload example

{
  "instrument": "EURUSD",
  "orderType": "limitBuy",
  "limitPrice": 1.085,
  "stopPrice": null,
  "quantity": 1,
  "timeInForce": "GTC"
}

Hub return type

Task

The invoke completes when the server accepts the request. Portfolio, trade, and status updates are pushed asynchronously on the client events below.

Related message types

/// <summary>
    /// Order payload sent from the client via DefaultHub.SendOrder
    /// </summary>
    public class OrderDetails
    {
        public string Instrument { get; set; }

        /// <summary>
        /// marketBuy | marketSell | limitBuy | limitSell | stopBuy | stopSell
        /// </summary>
        public string OrderType { get; set; }

        public decimal? LimitPrice { get; set; }

        public decimal? StopPrice { get; set; }

        public decimal Quantity { get; set; }

        public string TimeInForce { get; set; }
    }
OrderDetailsTypeDescriptionExample value
Instrumentstring

Trading symbol string sent to the hub (not the full Instrument object).

See TypeScript Instrument contract

"EURUSD"
OrderTypestring

marketBuy | marketSell | limitBuy | limitSell | stopBuy | stopSell

"limitBuy"
LimitPricedecimal?1.085
StopPricedecimal?null
Quantitydecimal1
TimeInForcestring"GTC"

Example JSON

{
  "instrument": "EURUSD",
  "orderType": "limitBuy",
  "limitPrice": 1.085,
  "stopPrice": null,
  "quantity": 1,
  "timeInForce": "GTC"
}

Related TypeScript contracts

Expected client events

Alipay
Stripe
Eurex
AWS
Azure
Google Cloud
Currenex
Velocity Trade
Bitcoin
CME
Interactive Brokers
Kraken
FIX API
XTX
Bloomberg
Binance

Launch Your Platform.

Get Started.