Longbridge

Get current-period business segment revenue breakdown for a symbol. Returns {total, currency, report_txt, fp_start, fp_end, rpt_date, business: [{id, name, value, percent, yoy}], regionals: [same shape; may be empty]}.

business_segments

Get historical business segment revenue trends (by period and category). Returns historical[].{date, total, currency, business[{name,percent,value}], regionals[{name,percent,value}]}

business_segments_history

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. When Greek indexes (Delta, Gamma, Theta, Vega, Rho) are requested, they are normalized: theta is the per-day value (one day's time decay), vega is the price change per 1% change in implied volatility, and rho is the price change per 1% change in the risk-free interest rate.

calc_indexes

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. If the account's entitlement caps out below the requested count, this returns as many candles as allowed instead of erroring — check the returned array length against count if an exact number matters.

candlesticks

Get capital distribution for a symbol. Returns {timestamp, capital_in{large, medium, small}, capital_out{large, medium, small}, data_available} (decimal strings in settlement currency). data_available is false for symbols with no capital-flow data (e.g. indices) — the other fields are still present but meaningless zeros in that case.

capital_distribution

Get capital inflow time series for the symbol (same-day data). Returns a top-level array of {timestamp, inflow}.

capital_flow

Get cash flow records (deposits, withdrawals, dividends). Returns a top-level array of {transaction_flow_name, direction (In/Out), business_type, balance (the amount moved), currency, business_time, symbol, description}. start_at/end_at: RFC3339 or yyyy-mm-dd. direction and business_type are unreliable upstream (always Out / 0); use the sign of balance. US accounts get a US-specific variant: the same array without business_type (see biz_code, biz_code_name); balance is signed (0 when no cash moved, e.g. crypto transfers) and direction comes from its sign, or the quantity's when it is 0 (Unknown when both are 0); plus quantity, quantity_description, ref_no, equity_type; at most 2000 records, so getting 2000 means narrow the range. Newest first.

cash_flow

Get company overview. Returns a flat object of strings: name, company_name, ticker, market, sector, category, region, founded, listing_date, employees, chairman, manager, website, address, profile, … US accounts querying a .US symbol get a US-specific variant {intro, market_cap, ccy_symbol, top_rank_tags[], share_list[], detail_url}. The region is detected from the account automatically.

company

Get corporate events for a symbol: earnings dates, dividends, splits, buybacks, name changes, etc. Returns items[]{id, date (YYYYMMDD), date_type, act_type, act_desc, action (kind code, e.g. ReportDate, DividendExDate), recent, is_delay, delay_content, live}; date_type / act_type / act_desc are localized text, and live is the linked broadcast (e.g. an earnings call: {name, started_at, symbols[]}) or null.

corp_action

Create a new community sharelist with a name and optional description. Returns the created sharelist object including its id, name, and description.

sharelist_create

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

topic_create

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

Create a new watchlist group. Returns the created group {id, name}. Optionally pass securities (e.g. ["AAPL.US", "700.HK"]) to pre-populate.

create_watchlist_group

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. Returns a bare JSON string, not an object.

now

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

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

sharelist_delete

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

delete_watchlist_group

Disable a price alert by alert_id. Returns {alert_id, enabled: false} on success. Use alert_list to find the numeric alert_id.

alert_disable

Get dividend history for the symbol. Returns {total, list: [{id, desc, counter_id, record_date, ex_date, payment_date}]}; the amount is only in the desc text. US accounts querying a .US symbol get a US-specific variant (e.g. dividend_yield_ttm is a percent value: 0.34 means 0.34%). The region is detected from the account automatically.

dividend

Get detailed dividend distribution schemes. Returns list[]{desc, record_date, ex_date, payment_date}, newest first. desc is the localized human-readable scheme (amount and currency in text, may contain a newline); there are no separate cash/stock amount fields.

dividend_detail

Enable a price alert by alert_id. Returns {alert_id, enabled: true} on success. Use alert_list to find the numeric alert_id.

alert_enable

Estimate maximum buy/sell quantity for a symbol. Returns {cash_max_qty, margin_max_qty} (decimal strings). 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

Get Longbridge's account-conversion exchange rates for all supported currencies (the rates used to value assets in an account's currency). Returns {exchanges[]{base_currency, other_currency, average_rate}}: average_rate is the value of 1 other_currency in base_currency (e.g. base USD, other HKD, 0.12743 = 1 HKD is 0.12743 USD). US accounts get a US-specific variant: the US account's rates in the same shape, one row per pair (the reference rate, else am) with spec_key naming the rate type. For public market reference rates or history, use fx_rate.

exchange_rate

Get company executive and board member information. Returns professional_list[] (one entry per symbol) {symbol, total, forward_url, professionals[]{id, name, title, biography, wiki_url}}.

executive

Get a pre-signed download URL for a statement data file (obtained from statement_list). Returns {url}; fetch that URL to get the statement JSON.

statement_export

Public ECB foreign-exchange reference rates (via Frankfurter): one rate per business day, not live or tradable, no bid/ask. Latest by default, or a historical date / daily series. Returns {base, date, rates{CODE: rate}, source}; a series keys rates by yyyy-mm-dd. rate is CODE per 1 base (base USD, HKD 7.8472), the opposite direction to exchange_rate; for a cross rate, set base instead of dividing. Cite date with the rate: it is the publication day, possibly before today.

fx_rate

Get regulatory filings (8-K, 10-Q, 10-K, etc.) for the symbol. Returns a top-level array of {id, title, description, file_name, file_urls[], publish_at}.

filings

Finance calendar by category: report (earnings) / dividend / split / ipo / macrodata (CPI, NFP, rates) / closed (holidays). start and end (YYYY-MM-DD) are optional, default today plus 7 days. Pass market (e.g. US) whenever the user cares about one market: an unfiltered week of earnings across all markets is several hundred KB and gets truncated. Returns {list: [{date, infos: [{symbol, counter_name, market, content, type, date, datetime, date_type, data_kv: [{type, value, value_raw}], star (macrodata), currency, …}]}]}, one entry per day.

finance_calendar

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). Each line item carries its newest 8 periods by default; set periods for more. Returns {report, list: {i_s|b_s|c_f: {indicators: [{title, currency, has_yoy, accounts: [{name, field, percent, tip, industry_ranking, values: [{year, period, fp_end, value, yoy, ratio}]}]}]}}}. US accounts querying a .US symbol without kind are routed to a US-specific overview endpoint (is_list/bs_list/cf_list); passing kind explicitly always uses the generic path.

financial_report

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. Returns a flat object: name, ticker, market, currency, report, fiscal_year, fiscal_period, fp_start, fp_end, opt_reports, report_desc, fo_* as {value, yoy, …}, and fr_* either a plain string (ratios) or {value, yoy} (amounts).

financial_report_snapshot

Get financial statements (income statement, balance sheet, or cash flow) for a security. kind: IS/BS/CF/ALL. report: af (annual, default), saf (semi-annual), qf (quarterly full), q1/q2/q3. Returns {report, currency, empty_fields, list[]}: list[] holds the reporting periods, most recent first, each with its fields[] line items; it can be empty when no data is available. US accounts querying a .US symbol are routed to a US-specific statement endpoint (same report vocabulary as the generic path): a single kind returns the same envelope, while kind=ALL/default fans out to IS+BS+CF and returns {income_statement, balance_sheet, cash_flow}, each holding that envelope, since the backend doesn't support a combined request; all other symbol/account combinations use the generic path.

financial_statement

Get EPS forecast history. Returns items[], one analyst consensus snapshot per forecast window: {forecast_start_date, forecast_end_date, forecast_eps_mean, forecast_eps_median, forecast_eps_lowest, forecast_eps_highest, institution_total, institution_up, institution_down}. Forecasts only, no actual EPS or surprise; use consensus for estimate-vs-actual.

forecast_eps

Get funds and ETFs that hold a given symbol. Returns lists[]{symbol (the fund's symbol), name, currency, position_ratio (weight of the queried stock in the fund, in percent), report_date}.

fund_holder

Get current fund positions. Returns list[].fund_info[]{counter_id, symbol_name, currency, holding_units, current_net_asset_value, cost_net_asset_value, net_asset_value_day}. counter_id is the fund id (e.g. UT/FD/HK0000384492); its last /-separated segment is the ISIN.

fund_positions

Get historical candlestick data by date range. Only symbol is required (with no start/end, the most recent 100 bars are returned — pass start/end for a specific range); period defaults to day (1m/5m/15m/30m/60m/day/week/month/year), forward_adjust to false, trade_sessions to all. Returns a top-level array of {timestamp, open, high, low, close, volume, turnover, trade_session}.

history_candlesticks_by_date

Get historical candlestick data by offset from a reference time. Only symbol is required; period defaults to day (1m/5m/15m/30m/60m/day/week/month/year), count to 100, forward_adjust/forward to false, trade_sessions to all. If the account's entitlement caps out below the requested count, this returns as many candles as allowed instead of erroring — check the returned array length against count if an exact number matters.

history_candlesticks_by_offset

Get every trade execution (fill) in a date range, auto-paginated to return the complete set (never truncated at the 1000-per-page cap). Returns a top-level array of {order_id, trade_id, symbol, side, quantity, price, trade_done_at}; trade_id is the stable dedupe key; side is "Unknown" when unresolved (US: the order could not be resolved; call order_detail(order_id) for it). start_at/end_at in RFC3339, or a bare yyyy-mm-dd read as a UTC day (US accounts: a New York EST/EDT day, matching history_orders). AP accounts are filtered by execution time (trade_done_at). US accounts read v1 history, which is not filtered by execution time and can lag across days near the range edges: widen the range by a day each side and filter on trade_done_at; side is filled from the account's orders in the range, then from order detail.

history_executions

Get historical market temperature time series for a market and date range (at most 3 years per call). Returns {type, list[]{temperature, valuation, sentiment, timestamp}}.

history_market_temperature

Get historical orders between dates (AP accounts: excludes today). Returns orders[]{order_id, symbol, side, status, quantity, price, submitted_at}. start_at/end_at in RFC3339. US accounts get a US-specific variant: the same array and field names as today_orders' US variant; a bare yyyy-mm-dd start_at/end_at is read as a New York (EST/EDT) day rather than UTC; the range is applied as given, so it includes today's orders when it covers today, and all orders in it (up to 500) are returned unless us_page/us_limit pick one page. today_orders' US window opens at 20:00 ET on the previous day, so orders placed from 20:00 ET yesterday appear in both a range ending yesterday and today_orders; dedupe by order_id when combining them.

history_orders

Show the IPO calendar. Returns {sub_num, win_num, preipo_num, ipo_num, timestamp, list[]{symbol, code, name, sub_date, sub_end_date, result_date, ipo_date, mart_date, state, state_stage, tags}} for upcoming and recent IPOs.

ipo_calendar