Finance

Longbridge

by Longbridge

Overview

Longbridge helps users research US/HK markets through ChatGPT with read-only access to quotes, charts, order book data, fundamentals, analyst research, finance calendars, news, filings, stock screeners, market movers, ranking lists, short interest.

Tools

account_balance

ChatGPT

Get account cash balance and asset summary. Returns balances[]{currency, total_cash, max_finance_amount, remaining_finance_amount, risk_level, margin_call}. Filter by currency (e.g. "USD", "HKD").

account_balance

ChatGPT

Get account cash balance and asset summary. Returns balances[]{currency, total_cash, max_finance_amount, remaining_finance_amount, risk_level, margin_call}. Filter by currency (e.g. "USD", "HKD").

ah_premium

ChatGPT

Get A/H share premium historical K-line data. Returns items[]{timestamp, open, high, low, close} representing the premium percentage over the given period.

ah_premium

ChatGPT

Get A/H share premium historical K-line data. Returns items[]{timestamp, open, high, low, close} representing the premium percentage over the given period.

ah_premium_intraday

ChatGPT

Get A/H share premium intraday time-share data. Returns items[]{timestamp, premium_rate} showing the intraday A/H premium percentage minute by minute.

ah_premium_intraday

ChatGPT

Get A/H share premium intraday time-share data. Returns items[]{timestamp, premium_rate} showing the intraday A/H premium percentage minute by minute.

alert_add

ChatGPT

Add a price alert. condition: price_rise/price_fall (absolute price) or percent_rise/percent_fall (relative %). frequency: once/daily/every. Returns created alert object.

alert_add

ChatGPT

Add a price alert. condition: price_rise/price_fall (absolute price) or percent_rise/percent_fall (relative %). frequency: once/daily/every. Returns created alert object.

alert_delete

ChatGPT

Delete a price alert by alert_id (numeric string from alert_list). Returns upstream API response on success; errors if alert_id is invalid.

alert_delete

ChatGPT

Delete a price alert by alert_id (numeric string from alert_list). Returns upstream API response on success; errors if alert_id is invalid.

alert_disable

ChatGPT

Disable a price alert by alert_id. Use alert_list to find the numeric alert_id.

alert_disable

ChatGPT

Disable a price alert by alert_id. Use alert_list to find the numeric alert_id.

alert_enable

ChatGPT

Enable a price alert by alert_id. Use alert_list to find the numeric alert_id.

alert_enable

ChatGPT

Enable a price alert by alert_id. Use alert_list to find the numeric alert_id.

alert_list

ChatGPT

Get all configured price alerts.

alert_list

ChatGPT

Get all configured price alerts.

anomaly

ChatGPT

Get market anomaly alerts (unusual price/volume changes). market: HK/US/CN/SG. symbol: optional, filter to a specific stock. count: results per page (default 50, max 100).

anomaly

ChatGPT

Get market anomaly alerts (unusual price/volume changes). market: HK/US/CN/SG. symbol: optional, filter to a specific stock. count: results per page (default 50, max 100).

broker_holding

ChatGPT

Get top broker holding data for a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

broker_holding

ChatGPT

Get top broker holding data for a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

broker_holding_daily

ChatGPT

Get daily holding history for a specific broker (by broker_id) in a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

broker_holding_daily

ChatGPT

Get daily holding history for a specific broker (by broker_id) in a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

broker_holding_detail

ChatGPT

Get full broker holding detail list for a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

broker_holding_detail

ChatGPT

Get full broker holding detail list for a symbol (HK stocks only; sourced from HKEX CCASS participant disclosure).

brokers

ChatGPT

Get broker queue (HK stocks only). Map broker IDs to names via participants.

brokers

ChatGPT

Get broker queue (HK stocks only). Map broker IDs to names via participants.

business_segments

ChatGPT

Get current-period business segment revenue breakdown for a symbol (name, percent, total, currency)

business_segments

ChatGPT

Get current-period business segment revenue breakdown for a symbol (name, percent, total, currency)

business_segments_history

ChatGPT

Get historical business segment revenue trends (by period and category).

business_segments_history

ChatGPT

Get historical business segment revenue trends (by period and category).

calc_indexes

ChatGPT

Calculate financial indexes for symbols. Pass symbols, and optionally indexes (e.g. ["PeTtmRatio","PbRatio","LastDone","TurnoverRate"]). When indexes is omitted or empty, defaults to ["LastDone","ChangeValue","ChangeRate","Volume","PeTtmRatio","PbRatio","DividendRatioTtm","TurnoverRate","TotalMarketValue"]. Returns per-symbol index values.

calc_indexes

ChatGPT

candlesticks

ChatGPT

Get candlestick data (OHLCV). Only symbol is required; period defaults to day, count to 100 (max 1000), forward_adjust to false, trade_sessions to all. period: 1m/5m/15m/30m/60m/day/week/month/year. trade_sessions: intraday/all

candlesticks

ChatGPT

capital_distribution

ChatGPT

Get capital distribution for a symbol.

capital_distribution

ChatGPT

Get capital distribution for a symbol.

capital_flow

ChatGPT

Get capital inflow/outflow time series. Returns items[]{timestamp, inflow, outflow, net_flow} for the symbol (same-day data).

capital_flow

ChatGPT

Get capital inflow/outflow time series. Returns items[]{timestamp, inflow, outflow, net_flow} for the symbol (same-day data).

cash_flow

ChatGPT

Get cash flow records (deposits, withdrawals, dividends). Returns items[]{transaction_type, amount, currency, balance, created_at, remark}. start_at/end_at in RFC3339.

cash_flow

ChatGPT

Get cash flow records (deposits, withdrawals, dividends). Returns items[]{transaction_type, amount, currency, balance, created_at, remark}. start_at/end_at in RFC3339.

company

ChatGPT

Get company overview.

company

ChatGPT

Get company overview.

consensus

ChatGPT

Get financial consensus estimates.

consensus

ChatGPT

Get financial consensus estimates.

constituent

ChatGPT

Get the constituents of an index or the asset allocation of an ETF. For an index (e.g. HSI.HK, .DJI.US) returns constituents[]{symbol, name, last_done, change_rate, market_cap, weight}. For an ETF (e.g. QQQ.US, 2800.HK) returns the asset allocation as info[] grouped by asset_type: 1=Holdings (top constituents with code, symbol, holding_detail), 2=Regional (country/region breakdown), 3=AssetClass (stock/bond/cash etc.), 4=Industry (sector breakdown). Each group has report_date and lists[]{name, position_ratio, name_locales}; Holdings groups additionally include code, symbol and holding_detail{industry_name, index_name, holding_type_name}.

constituent

ChatGPT

corp_action

ChatGPT

Get corporate actions (splits, buybacks, name changes).

corp_action

ChatGPT

Get corporate actions (splits, buybacks, name changes).

create_watchlist_group

ChatGPT

Create a new watchlist group. Optionally pass securities (e.g. ["AAPL.US", "700.HK"]) to pre-populate.

create_watchlist_group

ChatGPT

Create a new watchlist group. Optionally pass securities (e.g. ["AAPL.US", "700.HK"]) to pre-populate.

delete_watchlist_group

ChatGPT

Delete a watchlist group by id (numeric). Set purge=true to also remove its securities from all other groups.

delete_watchlist_group

ChatGPT

Delete a watchlist group by id (numeric). Set purge=true to also remove its securities from all other groups.

depth

ChatGPT

Get order book depth for a symbol. Up to 10 price levels.

depth

ChatGPT

Get order book depth for a symbol. Up to 10 price levels.

dividend

ChatGPT

Get dividend history.

dividend

ChatGPT

Get dividend history.

dividend_detail

ChatGPT

Get detailed dividend distribution scheme.

dividend_detail

ChatGPT

Get detailed dividend distribution scheme.

estimate_max_purchase_quantity

ChatGPT

Estimate maximum buy/sell quantity for a symbol. Only symbol is required; side (case-insensitive Buy/Sell) defaults to Buy, order_type (case-insensitive) defaults to LO, and price is optional.

estimate_max_purchase_quantity

ChatGPT

Estimate maximum buy/sell quantity for a symbol. Only symbol is required; side (case-insensitive Buy/Sell) defaults to Buy, order_type (case-insensitive) defaults to LO, and price is optional.

exchange_rate

ChatGPT

Get exchange rates for all supported currencies. Returns list[]{from_currency, to_currency, rate, timestamp} covering USD, HKD, CNY, SGD and others.

exchange_rate

ChatGPT

Get exchange rates for all supported currencies. Returns list[]{from_currency, to_currency, rate, timestamp} covering USD, HKD, CNY, SGD and others.

executive

ChatGPT

Get company executive and board member information.

executive

ChatGPT

Get company executive and board member information.

filings

ChatGPT

Get regulatory filings (8-K, 10-Q, 10-K, etc.). Returns items[]{id, title, type, language, filing_date, url} for the symbol.

filings

ChatGPT

Get regulatory filings (8-K, 10-Q, 10-K, etc.). Returns items[]{id, title, type, language, filing_date, url} for the symbol.

finance_calendar

ChatGPT

Get finance calendar events by category and date range. category: report (earnings + financials) / dividend / split (splits & reverse splits) / ipo / macrodata (CPI, NFP, rate decisions) / closed (market holidays).

finance_calendar

ChatGPT

financial_report

ChatGPT

Get financial reports (income statement, balance sheet, cash flow). kind: IS/BS/CF/ALL. report_type: af (annual), saf (semi-annual), q1/q2/q3, qf (quarterly full).

financial_report

ChatGPT

Get financial reports (income statement, balance sheet, cash flow). kind: IS/BS/CF/ALL. report_type: af (annual), saf (semi-annual), q1/q2/q3, qf (quarterly full).

financial_report_latest

ChatGPT

Get the latest financial report summary for a security.

financial_report_latest

ChatGPT

Get the latest financial report summary for a security.

financial_report_snapshot

ChatGPT

Get financial report snapshot: report_desc (text summary), fo_revenue/fo_ebit/fo_eps (actual vs forecast with yoy/cmp), fr_* financial ratios (ROE, margins, assets, cash flow). report: qf/saf/af.

financial_report_snapshot

ChatGPT

Get financial report snapshot: report_desc (text summary), fo_revenue/fo_ebit/fo_eps (actual vs forecast with yoy/cmp), fr_* financial ratios (ROE, margins, assets, cash flow). report: qf/saf/af.

financial_statement

ChatGPT

Get financial statements (income statement, balance sheet, or cash flow) for a security. kind: IS/BS/CF/ALL. report: af (annual), saf (semi-annual), qf (quarterly full), q1/q2/q3.

financial_statement

ChatGPT

Get financial statements (income statement, balance sheet, or cash flow) for a security. kind: IS/BS/CF/ALL. report: af (annual), saf (semi-annual), qf (quarterly full), q1/q2/q3.

forecast_eps

ChatGPT

Get EPS forecast and analyst estimate history.

forecast_eps

ChatGPT

Get EPS forecast and analyst estimate history.

fund_holder

ChatGPT

Get funds and ETFs that hold a given symbol.

fund_holder

ChatGPT

Get funds and ETFs that hold a given symbol.

fund_positions

ChatGPT

Get current fund positions.

fund_positions

ChatGPT

Get current fund positions.

history_candlesticks_by_date

ChatGPT

Get historical candlestick data by date range. period: 1m/5m/15m/30m/60m/day/week/month/year

history_candlesticks_by_date

ChatGPT

Get historical candlestick data by date range. period: 1m/5m/15m/30m/60m/day/week/month/year

history_candlesticks_by_offset

ChatGPT

Get historical candlestick data by offset from a reference time. period: 1m/5m/15m/30m/60m/day/week/month/year

history_candlesticks_by_offset

ChatGPT

Get historical candlestick data by offset from a reference time. period: 1m/5m/15m/30m/60m/day/week/month/year

history_executions

ChatGPT

Get historical trade executions between dates. Returns executions[]{order_id, symbol, side, quantity, price, trade_done_at}. start_at/end_at in RFC3339.

history_executions

ChatGPT

Get historical trade executions between dates. Returns executions[]{order_id, symbol, side, quantity, price, trade_done_at}. start_at/end_at in RFC3339.

history_market_temperature

ChatGPT

Get historical market temperature time series.

history_market_temperature

ChatGPT

Get historical market temperature time series.

history_orders

ChatGPT

Get historical orders between dates (excludes today). Returns orders[]{order_id, symbol, side, status, quantity, price, submitted_at}. start_at/end_at in RFC3339.

history_orders

ChatGPT

Get historical orders between dates (excludes today). Returns orders[]{order_id, symbol, side, status, quantity, price, submitted_at}. start_at/end_at in RFC3339.

industry_peers

ChatGPT

Hierarchical sub-sector tree for an industry group. Accepts BK counter_id from industry_rank (e.g. BK/US/IN00258). Each node shows stock count, daily change, and YTD change.

industry_peers

ChatGPT

Hierarchical sub-sector tree for an industry group. Accepts BK counter_id from industry_rank (e.g. BK/US/IN00258). Each node shows stock count, daily change, and YTD change.

industry_rank

ChatGPT

Industry ranking list by market (US/HK/CN/SG) and indicator (0=领涨/1=今日走势/2=人气/3=市值/4=营收/5=营收增长率/6=净利润/7=净利润增长率). sort_type: 0=单级 1=多层. Returns items[]{counter_id(BK/US/IN00258), name, chg, lists[]}. Pass counter_id directly to industry_peers.

industry_rank

ChatGPT

industry_valuation

ChatGPT

Get industry valuation comparison for peers.

industry_valuation

ChatGPT

Get industry valuation comparison for peers.

industry_valuation_dist

ChatGPT

Get industry PE/PB/PS valuation distribution.

industry_valuation_dist

ChatGPT

Get industry PE/PB/PS valuation distribution.

institution_rating

ChatGPT

Get institution rating summary.

institution_rating

ChatGPT

Get institution rating summary.

institution_rating_detail

ChatGPT

Get detailed historical institution ratings and target price history.

institution_rating_detail

ChatGPT

Get detailed historical institution ratings and target price history.

institution_rating_history

ChatGPT

Get institution rating history.

institution_rating_history

ChatGPT

Get institution rating history.

institution_rating_industry_rank

ChatGPT

Get peers ranked by institution analyst ratings in the same industry. Paginated.

institution_rating_industry_rank

ChatGPT

Get peers ranked by institution analyst ratings in the same industry. Paginated.

institutional_views

ChatGPT

Get monthly institutional rating distribution timeline.

institutional_views

ChatGPT

Get monthly institutional rating distribution timeline.

intraday

ChatGPT

Get intraday minute-by-minute price/volume data. trade_sessions: "intraday" (default, regular hours) or "all" (include pre-market and post-market)

intraday

ChatGPT

Get intraday minute-by-minute price/volume data. trade_sessions: "intraday" (default, regular hours) or "all" (include pre-market and post-market)

invest_relation

ChatGPT

Get investor relations events and announcements.

invest_relation

ChatGPT

Get investor relations events and announcements.

ipo_calendar

ChatGPT

Show the IPO calendar.

ipo_calendar

ChatGPT

Show the IPO calendar.

ipo_detail

ChatGPT

Show IPO detail for a symbol.

ipo_detail

ChatGPT

Show IPO detail for a symbol.

ipo_listed

ChatGPT

List recently listed IPO stocks (HK+US).

ipo_listed

ChatGPT

List recently listed IPO stocks (HK+US).

ipo_subscriptions

ChatGPT

List IPO stocks in subscription/pre-filing stage (HK+US).

ipo_subscriptions

ChatGPT

List IPO stocks in subscription/pre-filing stage (HK+US).

margin_ratio

ChatGPT

Get margin ratio for a symbol.

margin_ratio

ChatGPT

Get margin ratio for a symbol.

market_status

ChatGPT

Get current market trading status for all markets.

market_status

ChatGPT

Get current market trading status for all markets.

market_temperature

ChatGPT

Get current market sentiment temperature. market: HK/US/CN/SG.

market_temperature

ChatGPT

Get current market sentiment temperature. market: HK/US/CN/SG.

news

ChatGPT

Get latest news articles for a symbol. Returns items[]{id, title, source, publish_time, summary, url, related_symbols[]}.

news

ChatGPT

Get latest news articles for a symbol. Returns items[]{id, title, source, publish_time, summary, url, related_symbols[]}.

news_search

ChatGPT

Search news articles by keyword. Returns news_list[]{id, title, description, source_name, publish_at (RFC3339), score}. Paginate with score+publish_at_timestamp+id cursors.

news_search

ChatGPT

Search news articles by keyword. Returns news_list[]{id, title, description, source_name, publish_at (RFC3339), score}. Paginate with score+publish_at_timestamp+id cursors.

now

ChatGPT

Get current UTC time as an RFC3339 string (e.g. "2025-01-15T08:30:00Z"). Use to determine current date/time before making date-based queries.

now

ChatGPT

Get current UTC time as an RFC3339 string (e.g. "2025-01-15T08:30:00Z"). Use to determine current date/time before making date-based queries.

operating

ChatGPT

Get company operating metrics (HK stocks only).

operating

ChatGPT

Get company operating metrics (HK stocks only).

option_chain_expiry_date_list

ChatGPT

Get option chain expiry dates for a symbol (e.g. AAPL.US). Returns expiry_dates[] as "yyyy-mm-dd" strings. Use with option_chain_info_by_date to get strikes and Greeks.

option_chain_expiry_date_list

ChatGPT

Get option chain expiry dates for a symbol (e.g. AAPL.US). Returns expiry_dates[] as "yyyy-mm-dd" strings. Use with option_chain_info_by_date to get strikes and Greeks.

option_chain_info_by_date

ChatGPT

Get option chain for an expiry date. Returns strikePrices[]{strike_price, call{symbol, last_done, iv, delta, gamma}, put{symbol, last_done, iv, delta, gamma}}.

option_chain_info_by_date

ChatGPT

Get option chain for an expiry date. Returns strikePrices[]{strike_price, call{symbol, last_done, iv, delta, gamma}, put{symbol, last_done, iv, delta, gamma}}.

option_quote

ChatGPT

Get option quotes (max 500 symbols). Returns last_done, prev_close, open, high, low, volume, turnover, implied_volatility, delta, gamma, theta, vega, rho, open_interest per symbol.

option_quote

ChatGPT

Get option quotes (max 500 symbols). Returns last_done, prev_close, open, high, low, volume, turnover, implied_volatility, delta, gamma, theta, vega, rho, open_interest per symbol.

option_volume

ChatGPT

Get real-time option call/put volume stats for a US stock. Returns {call_volume, put_volume, put_call_ratio, call_oi, put_oi} and top active contracts.

option_volume

ChatGPT

Get real-time option call/put volume stats for a US stock. Returns {call_volume, put_volume, put_call_ratio, call_oi, put_oi} and top active contracts.

option_volume_daily

ChatGPT

Get daily historical option stats for a US stock. Returns items[]{date, call_volume, put_volume, put_call_vol_ratio, call_oi, put_oi, put_call_oi_ratio}.

option_volume_daily

ChatGPT

Get daily historical option stats for a US stock. Returns items[]{date, call_volume, put_volume, put_call_vol_ratio, call_oi, put_oi, put_call_oi_ratio}.

order_detail

ChatGPT

Get detailed information about a specific order.

order_detail

ChatGPT

Get detailed information about a specific order.

participants

ChatGPT

Get HK market participant broker information. Returns participants[]{broker_ids[], name_en, name_cn, name_hk}. Use broker_ids to interpret broker queue data.

participants

ChatGPT

Get HK market participant broker information. Returns participants[]{broker_ids[], name_en, name_cn, name_hk}. Use broker_ids to interpret broker queue data.

profit_analysis

ChatGPT

Get portfolio profit and loss analysis summary. start/end: optional date range in yyyy-mm-dd format. Both must be provided together — passing only one returns empty results.

profit_analysis

ChatGPT

Get portfolio profit and loss analysis summary. start/end: optional date range in yyyy-mm-dd format. Both must be provided together — passing only one returns empty results.

profit_analysis_detail

ChatGPT

Get detailed profit and loss analysis for a specific symbol. start/end: optional date range in yyyy-mm-dd format. Both must be provided together — passing only one returns empty results.

profit_analysis_detail

ChatGPT

Get detailed profit and loss analysis for a specific symbol. start/end: optional date range in yyyy-mm-dd format. Both must be provided together — passing only one returns empty results.

quant_run

ChatGPT

Run a quant indicator script against historical K-line data on the server. Executes the script server-side and returns the computed indicator/plot values as JSON. Periods: 1m, 5m, 15m, 30m, 1h, day, week, month, year (default: day). The optional input parameter accepts a JSON array matching the order of input.*() calls in the script, e.g. "[14,2.0]".

quant_run

ChatGPT

quote

ChatGPT

Get latest price quotes. Returns per symbol: last_done, prev_close, open, high, low, volume, turnover, change_rate, change_value, trade_status, timestamp.

quote

ChatGPT

Get latest price quotes. Returns per symbol: last_done, prev_close, open, high, low, volume, turnover, change_rate, change_value, trade_status, timestamp.

rank_categories

ChatGPT

Get rank tab category configurations for the popularity leaderboard. Pass a second_tags key (e.g. hot_all-us) to rank_list.

rank_categories

ChatGPT

Get rank tab category configurations for the popularity leaderboard. Pass a second_tags key (e.g. hot_all-us) to rank_list.

rank_list

ChatGPT

Get ranked stock list by leaderboard tab key. key: from rank_categories second_tags[].key (e.g. "hot_all-us", "hot_up-hk", "trade_heat-us"). market: inferred from key suffix (-us/-hk) or pass explicitly. size: results (default 20).

rank_list

ChatGPT

screener_indicators

ChatGPT

Get all available screener indicator keys with units and default value ranges. Technical indicators include a tech_values field showing available options (e.g. macd_day: {category:[goldenfork,deadcross], period:[day,week]}).

screener_indicators

ChatGPT

screener_recommend_strategies

ChatGPT

List platform-preset screener strategies. market: US|HK|CN|SG (default: US). Pass id to screener_search strategy_id to run, or screener_strategy to inspect filter conditions.

screener_recommend_strategies

ChatGPT

List platform-preset screener strategies. market: US|HK|CN|SG (default: US). Pass id to screener_search strategy_id to run, or screener_strategy to inspect filter conditions.

screener_search

ChatGPT

Screen stocks. market: US|HK|CN|SG (Mode B required; Mode A uses strategy's market). Mode A: strategy_id from screener_recommend_strategies — auto-runs saved strategy.

screener_search

ChatGPT

Screen stocks. market: US|HK|CN|SG (Mode B required; Mode A uses strategy's market). Mode A: strategy_id from screener_recommend_strategies — auto-runs saved strategy.

screener_strategy

ChatGPT

Inspect a screener strategy's filter conditions before running it. Use screener_search strategy_id to execute the strategy.

screener_strategy

ChatGPT

Inspect a screener strategy's filter conditions before running it. Use screener_search strategy_id to execute the strategy.

screener_user_strategies

ChatGPT

List the current user's saved screener strategies. market: US|HK|CN|SG (default: US). Pass id to screener_search strategy_id to run, or screener_strategy to inspect conditions.

screener_user_strategies

ChatGPT

List the current user's saved screener strategies. market: US|HK|CN|SG (default: US). Pass id to screener_search strategy_id to run, or screener_strategy to inspect conditions.

security_list

ChatGPT

Get security list for a market. Supports market: US, HK, CN, SG. category: "Overnight" (default). page: 1-based page number (default 1). count: records per page (default 50).

security_list

ChatGPT

Get security list for a market. Supports market: US, HK, CN, SG. category: "Overnight" (default). page: 1-based page number (default 1). count: records per page (default 50).

shareholder

ChatGPT

Get institutional shareholders for a symbol.

shareholder

ChatGPT

Get institutional shareholders for a symbol.

shareholder_detail

ChatGPT

Get a single shareholder's holding and trade history. Requires object_id from shareholder_top. Note: trading_details[] is empty for institutional (13F) holders — it is only populated for insider/individual filers (Form 4).

shareholder_detail

ChatGPT

shareholder_top

ChatGPT

Get Top 20 major shareholders (institutions, individuals, insiders) across reporting periods. Use object_id with shareholder_detail to drill into a holder's full trade history.

shareholder_top

ChatGPT

Get Top 20 major shareholders (institutions, individuals, insiders) across reporting periods. Use object_id with shareholder_detail to drill into a holder's full trade history.

sharelist_add

ChatGPT

Add securities to a community sharelist by id. Provide symbols (e.g. ["AAPL.US", "700.HK"]) to add. Returns upstream API response.

sharelist_add

ChatGPT

Add securities to a community sharelist by id. Provide symbols (e.g. ["AAPL.US", "700.HK"]) to add. Returns upstream API response.

sharelist_create

ChatGPT

Create a new community sharelist with a name and optional description.

sharelist_create

ChatGPT

Create a new community sharelist with a name and optional description.

sharelist_delete

ChatGPT

Delete a community sharelist by id (own lists only; subscribed lists cannot be deleted). Returns upstream API response on success.

sharelist_delete

ChatGPT

Delete a community sharelist by id (own lists only; subscribed lists cannot be deleted). Returns upstream API response on success.

sharelist_detail

ChatGPT

Get community sharelist detail by id.

sharelist_detail

ChatGPT

Get community sharelist detail by id.

sharelist_list

ChatGPT

List user's own and subscribed community sharelists.

sharelist_list

ChatGPT

List user's own and subscribed community sharelists.

sharelist_popular

ChatGPT

Get popular/trending community sharelists.

sharelist_popular

ChatGPT

Get popular/trending community sharelists.

sharelist_remove

ChatGPT

Remove securities from a community sharelist by id. Provide symbols to remove. Returns upstream API response on success.

sharelist_remove

ChatGPT

Remove securities from a community sharelist by id. Provide symbols to remove. Returns upstream API response on success.

sharelist_sort

ChatGPT

Reorder securities in a community sharelist by id. Provide symbols in the desired new order. Returns upstream API response on success.

sharelist_sort

ChatGPT

Reorder securities in a community sharelist by id. Provide symbols in the desired new order. Returns upstream API response on success.

short_margin

ChatGPT

Get short margin deposit details for the current account. Returns short positions with margin_amount, margin_rate, interest_rate, symbol, quantity per position.

short_margin

ChatGPT

Get short margin deposit details for the current account. Returns short positions with margin_amount, margin_rate, interest_rate, symbol, quantity per position.

short_positions

ChatGPT

Get short interest history (open short positions) for HK or US stocks. Market inferred from symbol suffix. count: 1–100 (default 20). Unified data[]{timestamp(RFC3339), short_shares(open short position in shares), rate(decimal ratio e.g. 0.009=0.9%), close}. US-only: avg_daily_vol, days_to_cover. HK-only: balance(outstanding short position in HKD). US source: FINRA bi-weekly. HK source: HKEX daily.

short_positions

ChatGPT

short_trades

ChatGPT

Get daily short-sale volume history for HK or US stocks. Market inferred from symbol suffix. last_timestamp: unix seconds (omit for latest). page_size: 1–100 (default 20). US source: FINRA/NASDAQ daily. HK source: HKEX daily.

short_trades

ChatGPT

statement_export

ChatGPT

Get a pre-signed download URL for a statement data file (obtained from statement_list).

statement_export

ChatGPT

Get a pre-signed download URL for a statement data file (obtained from statement_list).

statement_list

ChatGPT

List available account statements (daily/monthly). Use the id with statement_export to download.

statement_list

ChatGPT

List available account statements (daily/monthly). Use the id with statement_export to download.

static_info

ChatGPT

Get static info for securities. Returns per symbol: symbol, name_cn, name_en, exchange (e.g. NASDAQ), type (e.g. US_Stock), lot_size, listed_date, delisted (bool).

static_info

ChatGPT

Get static info for securities. Returns per symbol: symbol, name_cn, name_en, exchange (e.g. NASDAQ), type (e.g. US_Stock), lot_size, listed_date, delisted (bool).

stock_positions

ChatGPT

Get current stock positions across all channels.

stock_positions

ChatGPT

Get current stock positions across all channels.

today_executions

ChatGPT

Get today's trade executions (fills). Returns executions[]{order_id, symbol, side, quantity, price, trade_done_at}. Pass symbol or order_id to filter.

today_executions

ChatGPT

Get today's trade executions (fills). Returns executions[]{order_id, symbol, side, quantity, price, trade_done_at}. Pass symbol or order_id to filter.

today_orders

ChatGPT

Get orders placed today. Returns orders[]{order_id, symbol, side, order_type, status, quantity, price, submitted_at, executed_quantity, executed_price}. Pass symbol to filter.

today_orders

ChatGPT

Get orders placed today. Returns orders[]{order_id, symbol, side, order_type, status, quantity, price, submitted_at, executed_quantity, executed_price}. Pass symbol to filter.

top_movers

ChatGPT

Get stocks whose price fluctuation exceeds the 20-trading-day standard deviation, with correlated news reasons. markets: comma-separated HK/US/CN/SG (omit=all). sort: 0=time 1=change-magnitude 2=popularity/heat (default).

top_movers

ChatGPT

topic

ChatGPT

Get discussion topics for a symbol. Returns items[]{id, title, author, created_at, like_count, comment_count, content_summary}.

topic

ChatGPT

Get discussion topics for a symbol. Returns items[]{id, title, author, created_at, like_count, comment_count, content_summary}.

topic_create

ChatGPT

Create a new discussion topic. topic_type="post" (default) is plain text; "article" requires a non-empty title and accepts Markdown body.

topic_create

ChatGPT

Create a new discussion topic. topic_type="post" (default) is plain text; "article" requires a non-empty title and accepts Markdown body.

topic_create_reply

ChatGPT

Create a reply to a discussion topic. Pass reply_to_id to nest under another reply; omit for a top-level reply.

topic_create_reply

ChatGPT

Create a reply to a discussion topic. Pass reply_to_id to nest under another reply; omit for a top-level reply.

topic_detail

ChatGPT

Get discussion topic detail by topic_id.

topic_detail

ChatGPT

Get discussion topic detail by topic_id.

topic_replies

ChatGPT

Get replies to a discussion topic, paginated (page default 1, size default 20, range 1-50)

topic_replies

ChatGPT

Get replies to a discussion topic, paginated (page default 1, size default 20, range 1-50)

topic_search

ChatGPT

Search community topics/posts by keyword. Returns id, author, time, and excerpt.

topic_search

ChatGPT

Search community topics/posts by keyword. Returns id, author, time, and excerpt.

trade_stats

ChatGPT

Get trade statistics (buy/sell/neutral volume distribution). Returns items[]{price_range, buy_volume, sell_volume, neutral_volume} for price-volume profile.

trade_stats

ChatGPT

Get trade statistics (buy/sell/neutral volume distribution). Returns items[]{price_range, buy_volume, sell_volume, neutral_volume} for price-volume profile.

trades

ChatGPT

Get recent trades (max 1000). Returns trades[]{price, volume, timestamp, trade_type, direction} for the symbol.

trades

ChatGPT

Get recent trades (max 1000). Returns trades[]{price, volume, timestamp, trade_type, direction} for the symbol.

trading_days

ChatGPT

Get trading days for a market between dates. market: HK/US/CN/SG.

trading_days

ChatGPT

Get trading days for a market between dates. market: HK/US/CN/SG.

trading_session

ChatGPT

Get trading session schedule for all markets. Returns market_sessions[]{market, trade_sessions[]{beg_time, end_time, trade_session_type}}.

trading_session

ChatGPT

Get trading session schedule for all markets. Returns market_sessions[]{market, trade_sessions[]{beg_time, end_time, trade_session_type}}.

update_watchlist_group

ChatGPT

Update a watchlist group by id. Can rename (name param) or modify securities (securities + mode: add/remove/replace).

update_watchlist_group

ChatGPT

Update a watchlist group by id. Can rename (name param) or modify securities (securities + mode: add/remove/replace).

valuation

ChatGPT

Get valuation overview with peer comparison.

valuation

ChatGPT

Get valuation overview with peer comparison.

valuation_comparison

ChatGPT

Stock valuation comparison. Mode A (single): pass only symbol — server returns stock + auto-selected industry peers.

valuation_comparison

ChatGPT

Stock valuation comparison. Mode A (single): pass only symbol — server returns stock + auto-selected industry peers.

valuation_history

ChatGPT

Get detailed valuation history time series.

valuation_history

ChatGPT

Get detailed valuation history time series.

valuation_rank

ChatGPT

Get daily valuation rank (PE/PB/PS/dividend yield industry percentile) for a security over a date range. start/end in yyyymmdd format.

valuation_rank

ChatGPT

Get daily valuation rank (PE/PB/PS/dividend yield industry percentile) for a security over a date range. start/end in yyyymmdd format.

warrant_issuers

ChatGPT

Get HK warrant issuer information. Returns issuers[]{id, name_en, name_cn}. Use id in warrant_list issuer filter.

warrant_issuers

ChatGPT

Get HK warrant issuer information. Returns issuers[]{id, name_en, name_cn}. Use id in warrant_list issuer filter.

warrant_list

ChatGPT

Get filtered warrant list for an underlying symbol. Returns warrants[]{symbol, name, last_done, change_rate, implied_volatility, expiry_date, strike_price, leverage_ratio, outstanding_ratio}.

warrant_list

ChatGPT

Get filtered warrant list for an underlying symbol. Returns warrants[]{symbol, name, last_done, change_rate, implied_volatility, expiry_date, strike_price, leverage_ratio, outstanding_ratio}.

warrant_quote

ChatGPT

Get warrant quotes. Returns last_done, prev_close, open, high, low, volume, turnover, implied_volatility, delta, leverage_ratio, effective_leverage per symbol.

warrant_quote

ChatGPT

Get warrant quotes. Returns last_done, prev_close, open, high, low, volume, turnover, implied_volatility, delta, leverage_ratio, effective_leverage per symbol.