Order Operations

Place Order

Purpose

Submits an order to the configured trading account.

Signature

func (c *TradeClient) PlaceOrder(order model.OrderRequest) (*model.PlaceOrderResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OrderRequest

Returns

(*model.PlaceOrderResult, error). Key fields from model.PlaceOrderResult:

The returned order ID confirms only that the placement request was submitted. Continue querying the order to determine its final status.

Invocation example

result, err := tc.PlaceOrder(model.OrderRequest{
	Account: "U123456",
	Symbol: "AAPL",
	SecType: "STK",
	Action: "BUY",
	OrderType: "LMT",
	TotalQuantity: 1,
	LimitPrice: 310.00,
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "id": 123456789,
  "order_id": 100001,
  "subIds": [123456790],
  "orders": [
    {
      "id": 123456789,
      "orderId": 100001,
      "account": "U123456",
      "symbol": "AAPL",
      "secType": "STK",
      "action": "BUY",
      "orderType": "LMT",
      "limitPrice": 310.00,
      "totalQuantity": 1,
      "filledQuantity": 0,
      "status": "Initial"
    }
  ]
}

Rate limit

The base rate limit is 120 requests/min.

Preview Order

Purpose

Validates an order and estimates commission and margin without placing it.

Signature

func (c *TradeClient) PreviewOrder(order model.OrderRequest) (*model.PreviewResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OrderRequest

OrderLegRequest fields

AlgoParamsRequest fields

ContractLegRequest fields

Each OcaOrders entry uses the OrderRequest model above; the same fields are not repeated.

Returns

(*model.PreviewResult, error). Key fields from model.PreviewResult:

These fields may be absent for account types or scenarios where they do not apply. The Go model uses non-pointer float64 fields, so a missing value and an explicit zero both appear as 0.

Invocation example

result, err := tc.PreviewOrder(model.OrderRequest{
	Account: "U123456",
	Symbol: "AAPL",
	SecType: "STK",
	Action: "BUY",
	OrderType: "LMT",
	TotalQuantity: 1,
	LimitPrice: 310.00,
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "account": "U123456",
  "isPass": true,
  "commission": 0.99,
  "commissionCurrency": "USD",
  "marginCurrency": "USD",
  "initMargin": 31000.00,
  "initMarginBefore": 30000.00,
  "maintMargin": 28000.00,
  "maintMarginBefore": 27000.00,
  "equityWithLoan": 100000.00,
  "equityWithLoanBefore": 100500.00,
  "availableEE": 69000.00,
  "excessLiquidity": 72000.00,
  "overnightLiquidation": 71000.00,
  "gst": 0.00,
  "message": ""
}

Modify Order

Purpose

Changes an existing order identified by its global ID.

Signature

func (c *TradeClient) ModifyOrder(id int64, order model.OrderRequest) (*model.OrderIDResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.OrderRequest

OrderLegRequest fields

AlgoParamsRequest fields

ContractLegRequest fields

Each OcaOrders entry uses the OrderRequest model above; the same fields are not repeated.

Returns

(*model.OrderIDResult, error). Key fields from model.OrderIDResult:

The returned order ID confirms only that the modification request was submitted, not that the replacement values are effective. Continue querying until the new values appear or the order reaches a final status.

Invocation example

result, err := tc.ModifyOrder(123456789, model.OrderRequest{
	Account: "U123456",
	ID: 1,
	Action: "BUY",
	OrderType: "LMT",
	TotalQuantity: 1,
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "id": 123456789
}

Rate limit

The base rate limit is 120 requests/min.

Cancel Order

Purpose

Cancels an existing order identified by its global ID.

Signature

func (c *TradeClient) CancelOrder(id int64) (*model.OrderIDResult, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

Returns

(*model.OrderIDResult, error). Key fields from model.OrderIDResult:

The returned order ID confirms only that the cancellation request was submitted. Continue querying until Status is Cancelled or the order reaches another final state, such as a fill that completed first; request acceptance is not cancellation completion.

Invocation example

result, err := tc.CancelOrder(123456789)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "id": 123456789
}

Rate limit

The base rate limit is 120 requests/min.

Estimate Tradable Quantity

Purpose

Estimates cash-buy, margin-buy, short-sell, and position-sell quantities. The client fills an empty account field from the client default.

Signature

func (c *TradeClient) EstimateTradableQuantity(req model.EstimateTradableQuantityRequest) (*model.EstimateTradableQuantity, error)

Requires a trading account accessible through the configuration. Institutional accounts can authenticate with SecretKey.

Parameters

model.EstimateTradableQuantityRequest

Returns

(*model.EstimateTradableQuantity, error). Key fields from model.EstimateTradableQuantity:

Invocation example

result, err := tc.EstimateTradableQuantity(model.EstimateTradableQuantityRequest{
	Account: "U123456",
	Symbol: "AAPL",
	SecType: "STK",
	Action: "BUY",
	OrderType: "MKT",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%#v\n", result)

{
  "tradableQuantity": 320,
  "maxCashBuyQuantity": 100,
  "maxMarginBuyQuantity": 320,
  "maxShortSellQuantity": 0,
  "maxPositionSellQuantity": 0,
  "cashBuyingPower": 31000.00,
  "currency": "USD"
}

Rate limit

The base rate limit is 60 requests/min.