Change Logs
2026-09-22
Webull Cloud MCP Server: the AI Market walkthrough was replaced with a Grok demo recorded for Hong Kong.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| Docs | — | Webull Cloud MCP Server: the AI Market section was consolidated from two subsections (ChatGPT Apps, Claude Connectors) into a single Grok subsection, and the walkthrough video was replaced with a Hong Kong recording in place of the previous Singapore ones. | Webull Cloud MCP Server |
2026-09-20
Broker API: US options trading support — new Option Exercise and Get Option Contracts endpoints, plus option permissions, option legs on orders, and option position journals. Trading API: Hong Kong odd lot limit orders (
ODD_LOT_LIMIT) and an estimated transaction fee breakdown on order preview. Authentication documents:x-versionupdated fromv2tov3.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| Docs | — | x-version request header updated from v2 to v3. | Authentication Overview Signature Token |
| Docs | — | The worked signature example was updated from GET /openapi/account/list to GET /trading/accounts/list, in the prose and in both the Python and Java samples. | Signature |
| API | Trading API | Added ODD_LOT_LIMIT (Odd Lot Limit Order) to the Hong Kong Stock order_type enum. | Place Order Preview Order Get Order Detail List Order Executions List Order History List Open Orders |
| API | Trading API | Response adds estimated_transaction_fee_detail, breaking the estimated transaction fee into a commission object (actual_commission, receivable_commission) and an itemized fees array (type, actual_value, receivable_value). | Preview Order |
| API | Broker API | Option order support: instrument_type now accepts OPTION, and a legs array was added for option leg detail (instrument_type, market, symbol, option_type, option_expire_date, strike_price, quantity, side). Replace Order additionally adds combo_type, which is now required. | Place Order Preview Order Replace Order |
| API | Broker API | Response adds estimated_transaction_fee_detail with the same commission and itemized fee breakdown as the Trading API. | Preview Order |
| API | Broker API | Virtual account option permissions: trading_permissions adds US_OPTION_NORMAL, and a new option_level field (LV1–LV4) is required when US_OPTION_NORMAL is granted. The sub-account option level must not exceed the master account's. | Create Virtual Account Update Virtual Account Get Virtual Account List Virtual Accounts |
| API | Broker API | Added external_account_number, the end customer's account number in your own system, used as the client-defined segment of the virtual account number (V + Entity Code + this value). | Create Virtual Account |
| API | Broker API | Position journals support options: instrument_type adds OPTION, symbol now accepts OCC format, quantity is clarified as a positive number, and the reason field is documented as the failure reason returned when the terminal state is not COMPLETED. | Create Position Journal Get Position Journal Detail |
| API | Broker API | Activity enums extended: activity_type adds OTHER, and activity_sub_type adds OPTION_TRADE, FUND_TRADE, and OTHER. | List Cash Activities |
| API | Broker API | Response adds init_margin (initial margin). | Get Account Balance |
| API | Broker API | Added option response examples covering option_strategy, legs, option_type, option_expire_date, strike_price, and contract multiplier/deliverable fields. | List Account Positions Get Order Detail List Order History List Open Orders |
| API | Broker API | The instrument_type query parameter now accepts OPTION. | List Trade Calendar |
| API | Broker API | Added ODD_LOT_LIMIT to the order_type enum, and the execution status description was clarified to document FILLED (fully executed in this execution) and PARTIAL_FILLED (partially filled in this execution). | List Order Executions |
Add
| Category | API | Change | Link |
|---|---|---|---|
| API | Broker API | Added Option Exercise endpoint (POST /openapi/broker/option/exercise) under Broker Options. Submits an option exercise or do-not-exercise request. | Option Exercise |
| API | Broker API | Added Get Option Contracts endpoint (GET /broker/instruments/stocks/options/contracts/list) under Instrument. Returns option contract static information, queried by underlying symbol, contract status, and option attributes. Supports filtering by category (currently US_OPTION only), status, expiration date range, root_symbol, option_symbol, option_type, style, strike price bounds, and ppind, with optional show_deliverables and page_size/last_instrument_id pagination. | Get Option Contracts |
2026-09-12
Documentation: Refined selected descriptions to better align with current API capabilities.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| Docs | — | Optimized selected API documentation descriptions for improved clarity and consistency with currently supported interface capabilities. This documentation update does not change API behavior. | — |
2026-08-22
Trading API & Broker API: Updated
no_party_idsfield description in Place Order to clarify requirement for Relevant Regulated Intermediaries.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Place Order: Updated no_party_ids field description — added clarification that it is required for Relevant Regulated Intermediaries and should be omitted otherwise. | Place Order |
| API | Broker API | Place Order: Updated no_party_ids field description — added clarification that it is required for Relevant Regulated Intermediaries and should be omitted otherwise. | Place Order |
2026-08-20
Trading API & Broker API: Deprecated
place_timeandfill_timefields in Get Order Detail response.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Get Order Detail: place_time and fill_time fields are now deprecated. These fields will continue to be returned for backward compatibility but should no longer be used in new integrations. | Order Detail |
| API | Broker API | Get Order Detail: place_time and fill_time fields are now deprecated. These fields will continue to be returned for backward compatibility but should no longer be used in new integrations. | Order Detail |
2026-08-15
Trading API & Broke API & Market Data API Interface path change.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API & Broke API & Market Data API | Changes have been sent for some interface paths | — |
2026-08-14
Subscribe Trade Events documentation update.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Subscribe Trade Events: MODIFY_SUCCESS example order_status value changed from WORKING to SUBMITTED. | Subscribe Trade Events |
2026-08-08
AI-Friendly Resources: Added Webull CLI documentation.
Trading API: Added Query Order Executions endpoint. Instrument Stock List added
sub_categoryfield. Account Balance addedinit_marginfield.
New
| Category | API | Change | Link |
|---|---|---|---|
| Tool | CLI | Added Webull CLI — a single-binary Go command-line tool providing structured access to Webull OpenAPI for trading HK stocks, US stocks/ETFs, US options, and A-shares (Stock Connect), with multi-market data coverage. Supports JSON and CSV output, AK/SK authentication with 2FA, multi-profile management, and automation-friendly design for AI agents, scripts, and CI workflows. | Webull CLI |
| API | Trading API | Added Query Order Executions endpoint — query historical order execution records for a specific account, filterable by date range or client order ID. | Query Order Executions |
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Get Stock Instruments — Added sub_category request parameter to filter instruments by sub-category (e.g., COMMON_STOCK, ETF, PREFERRED_STOCK, WARRANT, UNITS, RIGHT). Added sub_category field to the response. | Get Stock Instruments |
| API | Trading API | Account Balance — Added init_margin field to the response, representing the initial margin requirement. | Account Balance |
2026-08-08
AI-Friendly Resources: Add Webull Cloud MCP Server.
Add
| Category | API | Change | Link |
|---|---|---|---|
| Docs | — | Webull Cloud MCP Server is has been launched. | Webull Cloud MCP Server |
2026-07-25
ND Broker API: Added US stock Take Profit / Stop Loss order support with OCO combo orders. Account Activities endpoint path updated.
New
| Category | API | Change | Link |
|---|---|---|---|
| API | ND Broker API | US Stock — Added Take Profit / Stop Loss order support with new combo_type values:MASTER — a primary order that triggers a take-profit or stop-loss order upon executionSTOP_PROFIT — a take-profit order triggered by the master orderSTOP_LOSS — a stop-loss order triggered by the master order | Place Order |
| API | ND Broker API | US Stock — Added OCO (One-Cancels-the-Other) combo order support. When one order in the OCO pair is executed, the other is automatically cancelled. | Place Order |
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | HK Broker API | Account Activities endpoint path changed from previous path to openapi/broker/activity/list | Get Account Activities |
2026-07-18
Expand trading instrument query capability.
Add
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Add instrument option contracts query interface: Get Option Contracts. | Get Option Contracts |
2026-06-28
Documentation: Added a new Error Codes reference page listing all API error codes with HTTP status, error_code, message, and description.
New
| Category | Change | Link |
|---|---|---|
| Documentation | Added Error Codes page — a comprehensive reference of all error codes (401, 403, 500) returned by the Webull OpenAPI. | Error Codes |
2026-06-27
Market Data API: Added Fundamentals module with 22 new endpoints and 4 new Screener endpoints under Non-Display Solution.
Trading API: Company Profile, Analyst Target Price and Analyst Rating moved to Market Data API > Fundamentals.
New
| Category | API | Change | Link |
|---|---|---|---|
| API | Market Data API | Added Fundamentals category under Non-Display Solution with 22 endpoints: Company Profile, Analyst Target Price, Analyst Rating, Forecast Eps, Filings, Earnings Calendar, Dividend Calendar, Capital Flow, Industry Comparison, Indicators, Income, Cashflow, Balancesheet, Alert, Fund Brief, Fund Performance, Fund NetValue, Fund Holdings, Fund Dividends, Fund Rating, Fund Splits, Fund Files, Fund Allocation | Fundamentals |
| API | Market Data API | Added 4 new endpoints to Screener under Non-Display Solution:Market Sectors — Get market sector listMarket Sectors Detail — Get sector constituent stocksHigh Dividend Rank — Get high dividend stocks ranking52 Week High/Low — Get 52 week high/low stocks | Market Sectors · Market Sectors Detail · High Dividend Rank · 52 Week High/Low |
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API | Instrument module: Company Profile, Analyst Target Price, and Analyst Rating moved to Market Data API > Non-Display Solution > Fundamentals | Fundamentals |
2026-06-13
Signature document update.
Gainers & Losers API returns update.
Top Active Screener endpoint has been renamed.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| Docs | — | Signature document content updated by part format. | Signature |
| API | Market Data API | Gainers & Losers endpoint response added relative_volume_10d field. | Gainers & Losers |
| API | Market Data API | Screener endpoint name and URL changed from most-active to top-active. | Top Active |
2026-06-06
Trading API & Broker API: Stock Instrument endpoints added margin requirement ratio fields.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Trading API Broker API | Get Stock Instrument response now returns four additional margin fields:intraday_margin_long — Intraday margin requirement ratio for long positionintraday_margin_short — Intraday margin requirement ratio for short positionmaintenance_margin_long — Maintenance margin requirement ratio for long positionmaintenance_margin_short — Maintenance margin requirement ratio for short position | Get Stock Instrument Get Stock Instrument |
2026-05-30
Broker API: W-8BEN information fields expanded across all four Virtual Account endpoints.
Market Data API: Added Options market data under Non-Display Solution.
Changed
| Category | API | Change | Link |
|---|---|---|---|
| API | Broker API | w8ben_info request body in Create Virtual Account and Update Virtual Account now requires additional fields: first_name, last_name, middle_name, home_address, mail_address | Create Virtual Account · Update Virtual Account |
| API | Broker API | w8ben_info response in Get Virtual Account Detail and List Virtual Accounts now returns additional fields: first_name, last_name, middle_name, home_address, mail_address | Get Virtual Account Detail · List Virtual Accounts |
New
| Category | API | Change | Link |
|---|---|---|---|
| API | Market Data API | Added Options market data endpoints under Non-Display Solution: Tick, Snapshot, Historical Bars | Option Market Data |
2026-05-16
New MCP tools and Skills endpoints added for market data, instruments, and watchlist management.
New
| Category | API | Change | Link |
|---|---|---|---|
| MCP | Market Data API | Added new MCP tools: get_stock_noii_bars, get_stock_noii_snapshot, get_gainers_losers, get_most_active | MCP |
| MCP | Trading API | Added new MCP tools: get_futures_instruments, get_futures_products, get_futures_product_class, get_company_profile, get_analyst_rating, get_analyst_target_price, get_watchlists, create_watchlist, update_watchlist, delete_watchlist, get_watchlist_instruments, add_watchlist_instruments, remove_watchlist_instruments, update_watchlist_instruments | MCP |
| Skills | Market Data API | Added new Skills endpoints: stock-noii-bars, stock-noii-snapshot, stock-gainers-losers, stock-most-active | Skills |
| Skills | Trading API | Added new Skills endpoints: instrument-company-profile, instrument-analyst-rating, instrument-analyst-target-price, instrument-futures-product-class, instrument-futures-products, instrument-futures-list, watchlist-list, watchlist-create, watchlist-delete, watchlist-update, watchlist-instruments-list, watchlist-instruments-add, watchlist-instruments-remove, watchlist-instruments-update | Skills |
2026-04-18
US Stock: Added combo order support (OTO/OCO/OTOCO) and new order types. HK Stock: Added new order types including Stop, Trailing Stop, and Touch orders.
New
| Category | Change | Link |
|---|---|---|
| API | US Stock — Added combo order support with new combo_type values:MASTER — a primary order that triggers a take-profit or stop-loss order upon executionSTOP_PROFIT — a take-profit orderSTOP_LOSS — a stop-loss orderOTO — One-Triggers-the-Other, an order that triggers another order upon executionOCO — One-Cancels-the-Other, a pair of orders where the execution of one cancels the otherOTOCO — One-Triggers-One-Cancels-the-Other, an order that triggers an OCO order set upon execution | Order Place |
| API | US Stock — Added new order types:TOUCH_MKT — Touch Market OrderTOUCH_LMT — Touch Limit OrderTRAILING_STOP_LOSS — Trailing Stop OrderTRAILING_STOP_LOSS_LIMIT — Trailing Stop Limit Order | Order Place |
| API | HK Stock — Added new order types:STOP_LOSS — Stop OrderSTOP_LOSS_LIMIT — Stop Limit OrderTRAILING_STOP_LOSS — Trailing Stop OrderTRAILING_STOP_LOSS_LIMIT — Trailing Stop Limit OrderTOUCH_MKT — Touch Market OrderTOUCH_LMT — Touch Limit Order | Order Place |
| Docs | Added Combo Orders documentation with request examples for Take-Profit/Stop-Loss, OTO, OCO, and OTOCO order flows | Order Place |
2026-04-04
AI assistants can now access Webull trading and market data via Model Context Protocol (MCP).
New
| Category | Change | Link |
|---|---|---|
| Docs | Added Webull MCP Server documentation — step-by-step setup guide for connecting AI assistants (Kiro, Cursor, Claude Desktop) to Webull OpenAPI via Model Context Protocol, including architecture overview, prerequisites, client configuration, authentication flow, available endpoints, and security recommendations | Webull MCP Server |
2026-03-28
Order Detail endpoint: added fee fields. Subscribe Trade Events: added fee fields to event payload.
Changed
| Category | Change | Link |
|---|---|---|
| API | Order Detail endpoint added actual_commission, receivable_commission, and fees fields to the response | Order Detail |
| Docs | Subscribe Trade Events added actual_commission, receivable_commission, and fees fields to the event payload for FILLED, FINAL_FILLED, MODIFY_SUCCESS, and CANCEL_SUCCESS scenarios | Subscribe Trade Events |
2026-03-21
Added Broker API module with account management, instrument data, activities, assets, order trading, funding, journals, master data and event subscriptions.
New
| Category | Module | Change | Link |
|---|---|---|---|
| API | Account (ND) | Added Create Virtual Account endpoint | Create Virtual Account |
| Added Update Virtual Account endpoint | Update Virtual Account | ||
| Added Get Virtual Account Detail endpoint | Get Virtual Account Detail | ||
| Added List Virtual Accounts endpoint | List Virtual Accounts | ||
| Instrument | Added Get Stock Instrument endpoint | Get Stock Instrument | |
| Added Get Stock Locate Detail endpoint | Get Stock Locate Detail | ||
| Added Get Corporate Actions Detail endpoint | Get Corporate Actions Detail | ||
| Activities | Added Get Account Activities By Type endpoint | Get Account Activities By Type | |
| Assets | Added Account Balance endpoint | Account Balance | |
| Added Account Positions endpoint | Account Positions | ||
| Order | Added Preview Order endpoint | Preview Order | |
| Added Place Order endpoint | Place Order | ||
| Added Replace Order endpoint | Replace Order | ||
| Added Cancel Order endpoint | Cancel Order | ||
| Added Order Detail endpoint | Order Detail | ||
| Added Order History endpoint | Order History | ||
| Added Open Order endpoint | Open Order | ||
| Funding | Added Get FX Rate endpoint | Get FX Rate | |
| Added Create FX Request endpoint | Create FX Request | ||
| Added Get FX Detail endpoint | Get FX Detail | ||
| Added Create Instant Exchange Request endpoint | Create Instant Exchange Request | ||
| Added Get Instant Exchange Detail endpoint | Get Instant Exchange Detail | ||
| Added Create an Instant Funding Request endpoint | Create an Instant Funding Request | ||
| Added Get Instant Funding Detail endpoint | Get Instant Funding Detail | ||
| Journals | Added Create Cash Journal endpoint | Create Cash Journal | |
| Added Get Cash Journal Detail endpoint | Get Cash Journal Detail | ||
| Added Create Position Journal endpoint | Create Position Journal | ||
| Added Get Position Journal Detail endpoint | Get Position Journal Detail | ||
| Master Data | Added Trade Calendar endpoint | Trade Calendar | |
| Events | Added Broker Account Events subscription | Account Events | |
| Added Broker Instrument Events subscription | Instrument Events | ||
| Added Broker Corporate Actions Events subscription | CA Events | ||
| Added Broker Trade Events subscription | Trade Events | ||
| Added Broker Funding Events subscription | Funding Events | ||
| Added Broker Journal Events subscription | Journal Events | ||
| Added Broker Master Data Events subscription | Master Data Events |
2026-03-14
API Reference
Trading API
- Updated Order -> Trading: Added support for GTD (Good Till Date) orders. The
time_in_forcerequest parameter now includes theGTDtype, and a newexpire_daterequest parameter has been added.
2026-01-17
API Reference
Market Data API
- Added a new endpoint: Footprint
2025-12-13
New Features!
The API Status feature is now live. It supports real-time display of all online OpenAPI modules and email subscriptions for module status change notifications.
2025-11-29
Documentation
- Added code examples for the Assets, Accounts, and Orders modules in the documentation.
- Fixed broken links in the documentation.
API Reference
- Added the Trade Events guide.
2025-11-14
API Reference
- Improve the description information of the account, transaction, and asset interface fields.
2025-09-07
Documentation
- Add 2FA verification process for API usage. For details, please refer to token.md