Skip to content
Skip to main content

Changelog

All notable changes to the TradeZero API will be documented on this page.

May 14, 2026​

Documentation​

  • Developer portal refresh. The Trading, Options, Locates, Positions, Accounts, and WebSocket guides have been refreshed end-to-end - clearer prose, accurate response shapes for both paper and live accounts, and consistent paper-vs-live coverage throughout.
  • New recipes added. The Quickstart Recipes library has been expanded with new examples covering single-leg and multi-leg options, locates, order management, and the P&L and Portfolio WebSocket streams.

April 9, 2026​

Changed​

  • Locates API - locateType documentation corrected - locateType values 1 and 2 are functionally identical. The documentation has been updated to reflect this:
    • locateType values 1 and 2 are now documented together as 1 & 2 = Locate in all response field tables
    • The IntraDay string value ("IntraDay") is deprecated in the locateType parameter of the Sell (Credit) Locates endpoint. The API still accepts it for backward compatibility, but new integrations should send "Locate" for both codes 1 and 2. Recommended values: "Unknown", "Locate", "PreBorrow", "SingleUse"
    • Removed the restriction note stating that Accept was not available for locateType = 2

March 3, 2026​

New​

February 10, 2026​

New​

  • New Order Endpoint Added - new endpoint to retrieve an individual order by clientOrderId for the account:

    • GET /v1/api/accounts/{accountId}/order/{clientOrderId} - retrieves the details of a specific order using its clientOrderId
    • This endpoint provides a more efficient way to access order details without having to filter through all orders

Notes​

  • GET /order/{clientOrderId} response shape — Returns the same clean field set as POST /order for stock, single-leg option, and Mleg orders before legs[] is populated (accountId, clientOrderId, canceledQuantity, lastQuantity, …). Once a filled Mleg order's legs[] is populated, the response may switch to the WebSocket field set (account, userOrderId, cancelledQuantity, lastQty, …). GET /orders rows use the clean shape throughout. See Order shape across REST and WebSocket.

January 14, 2026​

Changed​

  • Order Response Structure - The API no longer returns the orderId field in order responses

    • All order operations now exclusively use clientOrderId for identification and tracking
    • If no clientOrderId is provided during order creation, the system will auto-generate one

  • Cancel Order Endpoint - The DELETE /v1/api/accounts/{accountId}/orders/{clientOrderId} endpoint now uses clientOrderId in the URL path

    • This change ensures consistency with the updated response structure
    • All order management now centers around the clientOrderId field

Migration Guide​

For Order Management:

  • Update your code to use only clientOrderId for order tracking and identification
  • Remove any references to orderId from response parsing logic
  • Ensure your order creation requests include a unique clientOrderId for better tracking
  • All cancellation requests should use the clientOrderId from your order tracking system

For Sell Locate Requests: Update your sell locate requests to use the new string format:

  • Old: "locateType": 1
  • New: "locateType": "Locate"

String Value Mapping (as of this release):

  • 0 (Unknown) → "Unknown"
  • 1 (Locate) → "Locate"
  • 2 (Intraday Only) → "IntraDay" (see April 9, 2026 - "IntraDay" is deprecated; the API still accepts it but new code should send "Locate" for both 1 and 2)
  • 3 (Pre-Borrow) → "PreBorrow"
  • 4 (Single Use) → "SingleUse"

December 11, 2025​

Changed​

  • Locates Endpoints - The GET /v1/api/accounts/{accountId}/locates endpoint has been split into two more specific endpoints:

    • GET /v1/api/accounts/{accountId}/locates/inventory - Returns only active locate inventory for the current trading day
    • GET /v1/api/accounts/{accountId}/locates/history - Returns all open/closed/expired locates for the day

    This change provides better performance and more granular control over the data you retrieve. Please update your integrations to use the appropriate endpoint.

Removed​

  • Locates Endpoint - GET /v1/api/accounts/{accountId}/locates has been removed and replaced with the two new endpoints above.

November 24, 2025​

Changed​

  • Order Cancellation Response - Order cancel requests now return full order details in the response instead of just a confirmation message. This provides better visibility into the canceled order's final state without having to make an additional REST call for order status.

Legend​

TypeDescription
NewNew features, endpoints, or capabilities added to the API
ChangedModifications to existing functionality or behavior
FixedIssue fixes and behavior corrections
DeprecatedFeatures that will be removed in a future version
RemovedFeatures that have been removed from the API
SecuritySecurity-related updates and improvements
info

For breaking changes, migration guides, or questions about updates, please contact our support team.