Appendix

Client constructors

pub fn QuoteClient::new(http_client: HttpClient) -> QuoteClient
pub fn TradeClient::new(http_client: HttpClient, account: impl Into<String>) -> TradeClient
pub fn TradeClient::with_secret_key(http_client: HttpClient, account: impl Into<String>, secret_key: impl Into<String>) -> TradeClient

Build quote HTTP clients with HttpClient::with_quote_server(config) and trade clients with HttpClient::new(config). Constructors take ownership.

Types and defaults

  • Requests use snake_case; most Option<T> fields default to None and are omitted.
  • Responses normally deserialize camelCase. PlaceOrderResult.order_id is a snake_case wire exception.
  • Times are generally i64 Unix milliseconds; explicit dates are String YYYY-MM-DD.
  • Prices/amounts are mainly f64; quantities are i64 or f64 exactly as modeled.
  • Empty responses become empty Vec, None, or T::default() according to the method.
  • Date/OCC option helpers infer timezone; _tz variants specify one.
  • The current model field is OptionAnalysis.implied_vol30_days, not implied_vol_30_days.

Errors, permissions, rate limits

TigerError covers configuration, serialization, HTTP, signatures, and server business errors. Do not blindly retry mutations. Quote licenses, account type, trading permission, market state, and buying power can reject calls. The SDK declares only a few client defaults, not universal server batch/time/rate limits; follow each API and account response.

Links

Pages in this section


Did this page help you?