Improved
New descriptions and examples across the API reference
November 6th, 2026
Broker API
Adds missing descriptions and examples to the Broker API reference and corrects how several documented fields render. Request and response shapes are unchanged.
- Documents the request body for creating a signed agreement.
- Adds an example for the idempotency key conflict error on journal creation.
- Adds examples for
JITReportDownloadURLfields on JIT reports. - Adds a description and examples for
PortfolioHistoryError. - Adds an example for
account_sub_typeonAccountCreationRequest. - Fixes rendering so the correct descriptions and defaults appear for
account_type,account_sub_type, andminor_identityonAccountCreationRequest,securitieson the ACATS transfer details,travel_rule_infoonWhitelistedAddress, and the ACATS pagination tokens. - The deprecation notices for
belongs_toandcreated_byon the admin action event schema are now visible, and their descriptions no longer repeat the deprecation reason.
Affected Endpoints
POST /v1/agreementsPOST /v1/journalsPOST /v1/accountsPOST /v1beta1/acats/{account_id}GET /v2/events/admin-actionsGET /v1/transfers/jit/reportsGET /v1/trading/accounts/{account_id}/account/portfolio/historyPOST /v1/accounts/{account_id}/wallets/whitelistsGET /v1/accounts/{account_id}/wallets/whitelists
Trading API
Adds missing descriptions and examples to the Trading API reference. Request and response shapes are unchanged.
- Adds a response example for the
PortfolioHistoryschema. - Adds a description and examples for
PortfolioHistoryError. - Fixes rendering so the documented description for
travel_rule_infoonWhitelistedAddressappears.
Affected Endpoints
GET /v2/account/portfolio/historyPOST /v2/wallets/whitelistsGET /v2/wallets/whitelists