Skip to main content

Overview

The Orders API allows you to execute trades, modify existing orders, cancel orders, and preview orders before execution.

Package Reference

Methods

PlaceOrder()

Place a new trading order.
Parameters:
  • Symbol (string): Stock symbol
  • Quantity (int): Number of shares
  • Side (string): “buy” or “sell”
  • OrderType (string): “market”, “limit”, “stop”, “stop_limit”
  • Price (float64, optional): Limit price
  • StopPrice (float64, optional): Stop price
  • TimeInForce (string): “day”, “gtc”, “ioc”, “fok”
Returns: *Order, error

UpdateOrder()

Modify an existing order.
Parameters:
  • orderID (string): Order ID
  • update (*OrderUpdate): Fields to update
Returns: *Order, error

CancelOrder()

Cancel an active order.
Parameters:
  • orderID (string): Order ID to cancel
Returns: error

PreviewOrder()

Preview order before placing.
Returns: *OrderPreview, error

Order Types

Market Orders

Limit Orders

Stop Orders

Stop-Limit Orders

Examples

Preview Before Trading

Bracket Order Strategy

Type Definitions

Error Handling