Webull OpenAPI

Get cryptocurrency instrument info. Two modes: (1) Query by symbols — pass symbols. (2) Query all — omit symbols, use page_size/last_instrument_id for pagination. category: US_CRYPTO. status: OC (Tradable), CO (Liquidate only), NT (Non-Tradable). Returns: symbol, name, instrument_type, exchange.

Get cryptocurrency real-time snapshot. Returns: symbol, price, change, change_ratio, bid, ask.

Get event contract OHLCV bars. Returns: time, open, high, low, close, volume.

Get event contract category list. Returns: category_id, name.

Get event contract order book depth. Returns: symbol, bids, asks.

Get events within a series. status: TRADABLE, EXPIRED, SETTLED. Returns: event_id, name, status, expiration_date.

Get event contract instruments by series. expiration_date_after: filter items expiring after date (YYYY-MM-DD, default today). Returns: symbol, name, instrument_type, exchange.

Get event contract series (recurring event templates). category: ECONOMICS, FINANCIALS, POLITICS, ENTERTAINMENT, SCIENCE_TECHNOLOGY, CLIMATE_WEATHER, TRANSPORTATION, CRYPTO, SPORTS. Returns: series_id, name, category.

Get event contract real-time snapshot. Returns: symbol, price, change, change_ratio, volume, bid, ask.

Get event contract tick-by-tick trade data. Returns: time, price, volume, side.

Get financial alert (next report estimates vs last year) for a stock. Returns: start_date, end_date, fiscal_year, fiscal_period, currency, eps_est, eps_ly, rev_est, rev_ly.

Get financial indicators (key ratios/metrics) for a stock across periods. Returns: currency and a map of indicator name to a series of {fiscal_year, fiscal_period, value}.

Get fund asset allocation by date. Returns: date, aum, and cash/bond/stock/preferred/convertible/other allocations each with value and ratio.

Get fund brief information. Returns: name, launch_date, benchmark, investment_objective, aum, issuer, custodian, and managers list.

Get fund dividend history (paginated). Returns: share_date, publish_date, pay_date, record_date, dps.

Get fund files/documents. Returns: publish_date, url, type, file_name.

Get fund top 10 holdings. Returns: target_symbol, stock_name, share_held_pct, share_held_chg_pct, maturity_date, update_time.

Get fund net value (NAV) history. Returns: date, currency, net_value.

Get fund performance returns over multiple horizons. Returns: currency, end_date, return_1m, return_3m, return_6m, return_1y, return_3y, return_5y, return_10y, return_si.

Get fund rating history. Returns: rating_date, rating_agency, rating_cycle, rating_results.

Get fund split history. Returns: split_date, split_type, split_ratio, from, to.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Description is built at runtime.

Get top gainers or losers ranking by price change. Use direction=DESC for gainers, direction=ASC for losers. Returns: instrument_id, symbol, name, price, change, change_ratio, volume, market_value, turnover_rate, amplitude.

Get high dividend stocks ranking. Returns: instrument_id, symbol, name, price, change_ratio, volume, market_value, yield, dividend, ex_date, pe_ttm.

Get income statement for a stock across periods. Returns per period: fiscal_year, fiscal_period, end_date, currency, total_revenue, gross_profit, op_income, net_income, diluted_eps, dps.

Get stock/ETF instrument info. Two modes: (1) Query by symbols — pass symbols, no pagination needed. (2) Query by category — omit symbols, use page_size/last_instrument_id for pagination. category: US_STOCK, HK_STOCK, JP_STOCK, CN_STOCK. sub_category: optional sub-classification filter within the category (e.g. COMMON_STOCK, ETF, PREFERRED_STOCK, WARRANT, UNITS, RIGHT). status: OC (Tradable), CO (Liquidate only), NT (Non-Tradable). Returns: symbol, name, instrument_type, exchange, sub_category.

Get market sector overview ranking. Returns per sector: id, name, change_ratio, volume, market_value, advanced, declined, flat, and a short list of leading stocks (symbol, name, instrument_id).

Get the stock list and statistics for a specific market sector. Returns: sector id, name, change_ratio, advanced/declined/flat counts, and a list of stocks with symbol, name, price, close, change_ratio, volume, market_value, turnover_rate, amplitude, high, low.

Get most actively traded stocks ranking. Ranked by volume, relative volume, turnover, turnover rate, or amplitude. Returns: instrument_id, symbol, name, price, change, change_ratio, volume, market_value, relative_volume_10d.

Get all current open/pending orders. Returns same fields as get_order_history.

Get option historical OHLCV bars (batch). Requires paid option market data subscription. symbols: Comma-separated option symbols. category: US_OPTION. timespan: M1, M5, M15, M30, M60, M120, M240, D, W, M, Y (default D). count: Number of bars, default 200, max 1200. Returns: time, open, high, low, close, volume per bar.

Get option contract list by underlying symbols and filters. Supported regions: US, HK, JP. category: US_OPTION. underlying_symbols: Comma-separated underlying symbols, e.g. AAPL,MSFT. option_type: CALL or PUT (optional). start_date/end_date: Expiration date range, format YYYY-MM-DD. strike_price_gte/strike_price_lte: Strike price range filter. status: LISTING (default), DELISTING. page_size: Default 10, max 1000. Returns: option_symbol, underlying_symbol, option_type, strike_price, expiration_date, style, status.

Get real-time option quote snapshots (batch, max 20 symbols). Requires paid option market data subscription. symbols: Comma-separated option symbols, e.g. AAPL260522C00300000,TSLA251219C00450000. category: US_OPTION. Returns: price, change, volume, open_interest, Greeks (delta/gamma/theta/vega/rho), IV, bid/ask.

Get option tick-by-tick trade data for a single option contract. Requires paid option market data subscription. symbol: Option symbol, e.g. AAPL260522C00300000. category: US_OPTION. count: Number of ticks, default 30, max 1200. Returns: time, price, volume, side (B/S/G/L/N).

Get single order details. Returns: client_order_id, symbol, side, order_type, quantity, filled_quantity, price, avg_filled_price, status, time_in_force, trading_session, create_time, update_time.

Get historical orders, default last 7 days. Returns: client_order_id, symbol, side, order_type, quantity, filled_quantity, price, avg_filled_price, status, time_in_force, create_time.

Get stock OHLCV bars in batch. Supports multiple symbols. Returns: time, open, high, low, close, volume.

Get OHLCV bars for a single stock. Returns: time, open, high, low, close, volume.

Get capital flow distribution for a stock by date. Returns: date, large_in, large_out, medium_in, medium_out, small_in, small_out.

Get dividend calendar for a stock (half a year before/after today, sorted ascending). Returns: symbol, market, currency, amount, div_type, declare_date, ex_div_date, record_date, pay_date.

Get earnings calendar for a stock (half a year before/after today, sorted ascending). Reports with an eps_actual value are already published. Returns: fiscal_year, fiscal_period, currency, expected_publish_date, eps_actual, eps_est, rev_actual, rev_est.

Get SEC filings for a US stock (last 3 years). Returns: symbol, category, and a list of filings with title, url, publish_date.

Get stock large order footprint (order flow). US_STOCK only. Returns: time, trading_session, total, delta, buy_total, sell_total, buy_detail, sell_detail.

Get forecast EPS for a stock: actual EPS of the most recent four disclosed fiscal periods plus latest analyst consensus estimate (up to 5 records, ascending). Returns: fiscal_year, fiscal_period, actual, est, reported.

Get industry comparison for a stock (up to 20 peers in the same industry). Returns: industry_name, type, fiscal_year, fiscal_period, and a ranked list of {symbol, name, rank, value}.

Get NOII (Net Order Imbalance Indicator) K-line data for a stock. NOII is published by NASDAQ before opening and closing auctions. Returns: instrument_id, symbol, imbalance_time, imbalance_ref_price, imbalance_near_price, imbalance_far_price, imbalance_action_type.

Get latest NOII (Net Order Imbalance Indicator) snapshot for a stock. Provides real-time supply-demand data during US stock auction phases. Opening auction: 9:28-9:30 AM ET; Closing auction: 3:50-4:00 PM ET. Returns: instrument_id, paired_shares, imbalance_shares, imbalance_side, imbalance_ref_price, imbalance_near_price, imbalance_far_price.

Get real-time stock bid/ask quotes with depth. Single symbol only. Returns: symbol, bid_price, bid_size, ask_price, ask_size.

Get real-time stock/ETF snapshot. Supports multiple symbols. Returns: symbol, price, pre_close, open, high, low, close, volume, change, change_ratio, bid, ask, turnover, eps, eps_ttm, lot_size, bps, extend_hour, overnight data.

Get stock tick-by-tick trade data. Returns: time, price, volume, side, trading_session.

Get all instruments in a watchlist. Returns: instrument_id, symbol, name, exchange_code, sort, added_time.

Get all watchlists for the current user. Returns: watchlist_id, name, sort, create_time, update_time.

List order execution records within a date range. Returns per execution: execution_id, order_id, client_order_id, symbol, execution_time, status, execution_type, side, order_type, total_quantity, limit_price, filled_quantity, filled_price, total_filled_qty, leaves_qty. Currently supported for Webull HK accounts only.

[US Only] Place an algorithmic order (TWAP, VWAP, POV). Only MARKET and LIMIT order types supported. TWAP/VWAP require max_target_percent (1-20). POV requires target_vol_percent (1-20). algo_start_time/algo_end_time: US Eastern Time, HH:mm:ss format (e.g. 09:30:00, 16:00:00). Returns: {client_order_id, order_id}

[US Only] Place a cryptocurrency order. Supports QTY and AMOUNT. No replace supported. Min position $2. Account: Crypto account. Call get_account_list first. order_type: MARKET (tif=IOC), LIMIT (tif=DAY/GTC), STOP_LOSS_LIMIT (tif=DAY/GTC). Returns: {client_order_id, order_id}

[US Only] Place an event contract order. LIMIT/DAY only. Account: Events Cash account. Call get_account_list first. event_outcome: Event outcome decision, possible values: yes, no. Returns: {client_order_id, order_id}

Description is built at runtime.

Place a single-leg option order. For multi-leg use place_option_strategy_order. Account: stock/option account (Individual Cash, Individual Margin, IRA). Call get_account_list first. order_type: MARKET, LIMIT, STOP_LOSS, STOP_LOSS_LIMIT. time_in_force: DAY, GTC. trading_session: CORE only. position_intent: BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN, SELL_TO_CLOSE (optional, US only). Leg-in / leg-out (US only, single-leg option): leg_in_or_out=LEG_IN adds this leg to an existing position; LEG_OUT closes a leg from a multi-leg position. position_id (from Account Positions API) is required when leg_…

[US Only] Place a multi-leg option strategy order (VERTICAL, STRADDLE, STRANGLE, BUTTERFLY, CONDOR, etc). Returns: {client_order_id, combo_order_id, order_id}

[US Only] Place a combo stock order. combo_type per leg: NORMAL, MASTER (triggers TP/SL), STOP_PROFIT, STOP_LOSS, OTO, OCO, OTOCO. Account: stock/option account. Call get_account_list first. Returns: {client_order_id, combo_order_id, order_id}

Place a stock order (single, non-combo). For combo orders use place_stock_combo_order. Account: stock/option account (Individual Cash, Individual Margin, IRA). Call get_account_list first. order_type by market: US Stock: MARKET, LIMIT, STOP_LOSS, STOP_LOSS_LIMIT, TRAILING_STOP_LOSS HK Stock: ENHANCED_LIMIT, AT_AUCTION, AT_AUCTION_LIMIT CN Connect: LIMIT time_in_force by market: US Stock: DAY, GTC HK Stock: DAY, GTC HK US Stock: DAY, GTC, GTD (requires expire_date) CN Connect: DAY trading_session by market: US Stock: CORE, ALL, NIGHT, ALL_DAY (overnight 8pm-8pm ET) HK Stock / …

Preview a futures order without submitting. Shows estimated costs and fees. Account: Futures account. Call get_account_list first. order_type: MARKET, LIMIT, STOP_LOSS, STOP_LOSS_LIMIT. Returns: estimated commission, margin requirements, buying power impact.

Preview an option order without submitting. Returns: estimated cost and fees.

Preview a stock order without submitting. Returns: estimated cost and fees. Account: stock/option account (Individual Cash, Individual Margin, IRA). JP (WEBULL_REGION_ID=jp, including US orders): account_tax_type is REQUIRED and must be GENERAL or SPECIFIC; margin_type must be ONE_DAY or INDEFINITE and is margin-account-only; close_contracts account eligibility is checked by the API backend.

Remove instruments from a watchlist by symbol and category.

[US Only] Modify an existing event contract order. Returns: {client_order_id, order_id}

Description is built at runtime.

Modify an existing option order. US region: auto-fetches leg IDs from order detail. Returns: {client_order_id, order_id}

Modify an existing stock order. For combo orders (US): pass orders array. For algo orders: can modify quantity, limit_price, max_target_percent (TWAP/VWAP), target_vol_percent (POV), algo_start_time, algo_end_time (HH:mm:ss ET). JP: if the original order has close_contracts, replace must include close_contracts with the same size and unchanged contract_id values; only quantity may change. Returns: {client_order_id, order_id}

Update an existing watchlist's name or sort order. Only provided fields will be updated.

Update the sort order of instruments in a watchlist.