Improved
Schema examples now use standard OpenAPI 3.1 examples
August 17th, 2026
Broker API
The Broker API description now expresses schema examples with the standard OpenAPI 3.1 examples keyword instead of the legacy x-examples extension. Values, ordering, and formatting are preserved, so request and response contracts are unchanged and downstream tooling such as SDK generators can now read them.
Alongside the migration:
- Empty example maps have been removed from the
CustodialAccountMinorIdentity,OrderClosedResponse, andNonTradeActivityEventschemas. PAPER_ONLYis now a documented value of theAccountStatusenum, and its description lists the account as limited to paper trading.accountsis now a documented value of theAdminActionCategoryenum.
Affected Endpoints
POST /v1/accountsGET /v1/accountsGET /v1/accounts/{account_id}PATCH /v1/accounts/{account_id}GET /v1/trading/accounts/{account_id}/accountGET /v2/events/admin-actions