Region: US
Changelog
Trading DashboardBroker Dashboard
Back to All
Improved

Schema descriptions and examples expanded across the API references

September 1st, 2026

Broker API

Adds descriptions to Broker schemas and simplifies several schema definitions with no change to the wire contract.

  • Shared activity schemas (CommonNTAActivityV2, CommonJournalActivityV2) and the options activity schemas now carry descriptions.
  • The DailyTradingLimit schema used by the JIT limits endpoint is now described.
  • ACATS transfer request and list-response schemas keep the same fields with tidier pagination and securities descriptions.
  • Single-item schema combinators are flattened; accepted and returned values are unchanged.

Affected Endpoints

  • GET /v2beta1/events/activities
  • GET /v2beta1/accounts/{account_id}/events/activities/{event_id}
  • GET /v1beta1/acats
  • GET /v1beta1/acats/{account_id}
  • POST /v1beta1/acats/{account_id}
  • GET /v1/transfers/jit/limits
  • GET /v2/events/funding/status

Trading API

Adds examples and descriptions across Trading schemas. Request and response shapes are unchanged.

  • CreateOrderRequest now shows examples for quantity, price, position_intent, ratio_qty, and multi-leg orders.
  • Watchlist creation and add-asset requests include symbol and name examples.
  • CreateWhitelistedAddressRequest, TokenizationRequest, and OptionContractsResponse include worked examples.
  • Shared activity schemas (CommonNTAActivityV2, CommonJournalActivityV2) and the options activity schemas now carry descriptions, and single-item combinators are flattened.

Affected Endpoints

  • POST /v2/orders
  • GET /v2/orders
  • GET /v2/orders/{order_id}
  • PATCH /v2/orders/{order_id}
  • GET /v2/orders:by_client_order_id
  • POST /v2/watchlists
  • POST /v2/watchlists/{watchlist_id}
  • POST /v2/watchlists:by_name
  • POST /v2/wallets/whitelists
  • GET /v2/tokenization/requests
  • GET /v2/tokenization/requests/{tokenization_request_id}
  • GET /v2/tokenization/requests:by_client_request_id
  • GET /v2/options/contracts
  • GET /v2beta1/events/activities

Market Data API

Adds descriptions and response examples to the fixed-income latest prices and quotes schemas, and flattens single-item combinators on historical data query parameters. Accepted parameter values and response shapes are unchanged.

Affected Endpoints

  • GET /v1beta1/fixed_income/latest/prices
  • GET /v1beta1/fixed_income/latest/quotes

Auth API

The Authentication API description now includes a top-level summary of the service. No endpoint behavior changed.