All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AccountBalance |
Account balance information
|
| AddAlertOptions |
|
| AdjustType |
Candlestick adjustment type
|
| AhPremiumIntraday |
Intraday A/H premium data points for a dual-listed security.
|
| AhPremiumKline |
One A/H premium data point.
|
| AhPremiumKlines |
Historical A/H premium K-line data for a dual-listed security.
|
| AhPremiumOptions |
|
| AhPremiumPeriod |
K-line period for A/H premium data.
|
| AlertCondition |
Alert trigger condition.
|
| AlertContext |
Price alert management context.
|
| AlertFrequency |
Alert notification frequency.
|
| AlertItem |
One price alert.
|
| AlertList |
|
| AlertSymbolGroup |
Alert items for one security.
|
| AnomalyItem |
One market anomaly event, e.g. a large block trade or margin buying surge.
|
| AnomalyResponse |
Market anomaly alerts response for a security.
|
| AssetContext |
Asset context for querying and downloading account statements
|
| AssetType |
Asset class category.
|
| AsyncCallback.AsyncTask |
|
| BalanceType |
Account balance type
|
| BrokerHoldingChanges |
Changes in a broker's holding or ratio over 1 / 5 / 20 / 60 day periods.
|
| BrokerHoldingDailyHistory |
Historical daily broker holding records for a security.
|
| BrokerHoldingDailyItem |
One day's broker holding record.
|
| BrokerHoldingDailyOptions |
|
| BrokerHoldingDetail |
Full broker holding detail list for a security.
|
| BrokerHoldingDetailItem |
One broker's full holding detail with ratio and share count changes.
|
| BrokerHoldingEntry |
One broker entry in a top net-buying or net-selling list.
|
| BrokerHoldingOptions |
|
| BrokerHoldingPeriod |
Lookback period for broker holding net change.
|
| BrokerHoldingTop |
Top brokers by net buying and net selling for a security.
|
| Brokers |
Brokers at a single price level in the bid/ask queue.
|
| BrokersHandler |
Callback interface for real-time broker queue push events
|
| BusinessSegmentHistoryItem |
One business/regional segment item in a historical snapshot.
|
| BusinessSegmentItem |
One business segment item (latest snapshot).
|
| BusinessSegments |
|
| BusinessSegmentsHistoricalItem |
One historical business segments snapshot.
|
| BusinessSegmentsHistory |
|
| BusinessSegmentsHistoryOptions |
|
| BuybackData |
|
| BuybackHistoryItem |
|
| BuybackRatios |
|
| CalcIndex |
Calculation index
|
| CalendarCategory |
Financial calendar event category.
|
| CalendarContext |
Financial calendar context
|
| CalendarDataKv |
One key-value data pair in a calendar event.
|
| CalendarDateGroup |
Events for one calendar date.
|
| CalendarEventInfo |
One financial calendar event.
|
| CalendarEventsResponse |
|
| Candlestick |
Candlestick (OHLCV bar).
|
| CandlestickHandler |
Callback interface for real-time candlestick push events
|
| CapitalDistribution |
Capital distribution by trade size.
|
| CapitalDistributionResponse |
Capital distribution response.
|
| CapitalFlowLine |
Capital flow data point for intraday capital flow.
|
| CashFlow |
Cash flow record
|
| CashFlowDirection |
Cash flow direction
|
| CashInfo |
Cash balance information for a single currency
|
| ChargeCategoryCode |
Order charge category code
|
| CommissionFreeStatus |
Commission-free status
|
| CompanyOverview |
Overview information for a listed company.
|
| Config |
Configuration options for Longbridge SDK
|
| ConsensusDetail |
Consensus estimate for one financial metric within a fiscal period.
|
| ConsensusReport |
Consensus report for one fiscal period.
|
| ConstituentStock |
One constituent stock of a market index.
|
| ContentContext |
Content context
|
| CorpActionItem |
One corporate action event.
|
| CorpActionLive |
Live stream associated with a corporate action.
|
| CorpActions |
Response containing corporate action events for a security.
|
| CreateSharelistOptions |
|
| CreateTopicOptions |
Options for creating a topic
|
| CreateWatchlistGroup |
Request object for creating a new watchlist group
|
| CreateWatchlistGroupResponse |
Response from creating a watchlist group
|
| DcaCalcDateOptions |
|
| DcaCalcDateResult |
|
| DcaContext |
Dollar-cost averaging (DCA) plan management context.
|
| DcaCreateOptions |
|
| DcaCreateResult |
Result of creating or updating a DCA plan.
|
| DCAFrequency |
Dollar-cost averaging investment frequency.
|
| DcaHistoryOptions |
|
| DcaHistoryRecord |
One DCA execution record.
|
| DcaHistoryResponse |
|
| DcaList |
|
| DcaListOptions |
|
| DcaPlan |
One DCA (dollar-cost averaging) investment plan.
|
| DcaStats |
|
| DCAStatus |
DCA plan status.
|
| DcaSupportInfo |
DCA support info for one security.
|
| DcaSupportList |
|
| DcaUpdateOptions |
|
| DeductionStatus |
Deduction status
|
| DeleteAlertOptions |
|
| DeleteWatchlistGroup |
Request object for deleting a watchlist group
|
| Depth |
A single price level in the order book depth.
|
| DepthHandler |
Callback interface for real-time order book depth push events
|
| DerivativeType |
Derivative type
|
| DividendItem |
A single dividend / distribution event.
|
| DividendList |
Response containing dividend / distribution events for a security.
|
| ErrorKind |
Error kind
|
| EstimateMaxPurchaseQuantityOptions |
Options for estimating the maximum purchase quantity
|
| EstimateMaxPurchaseQuantityResponse |
Response for max purchase quantity estimation
|
| ExchangeRate |
One currency exchange rate.
|
| ExchangeRates |
|
| Execution |
Order execution (fill)
|
| ExecutiveGroup |
Executives for one security.
|
| ExecutiveList |
Response containing executive groups (usually one per queried security).
|
| FilingItem |
Filing item
|
| FilterWarrantExpiryDate |
Filter warrant expiry date
|
| FilterWarrantInOutBoundsType |
Filter warrant in/out of the bounds type
|
| FinanceCalendarOptions |
|
| FinancialConsensus |
Financial consensus estimates response for a security.
|
| FinancialReportKind |
Financial report kind.
|
| FinancialReportOptions |
|
| FinancialReportPeriod |
Financial report period.
|
| FinancialReports |
Raw financial report data for a security.
|
| FinancialReportSnapshot |
|
| FinancialReportSnapshotOptions |
|
| FlowDirection |
Trade flow direction for profit-analysis flow records.
|
| FlowItem |
|
| ForecastEps |
EPS forecast snapshots for a security.
|
| ForecastEpsItem |
One EPS forecast snapshot covering a specific forecast window.
|
| FundamentalContext |
Fundamental data context — financial reports, analyst ratings, dividends,
valuation, company overview and more.
|
| FundHolder |
A fund or ETF that holds the queried security.
|
| FundHolders |
Response containing funds and ETFs that hold the queried security.
|
| FundPosition |
Fund position
|
| FundPositionChannel |
Fund positions grouped by account channel
|
| FundPositionsResponse |
Response containing all fund positions
|
| GetCashFlowOptions |
Options for querying cash flow records
|
| GetFundPositionsOptions |
Options for querying fund positions
|
| GetHistoryExecutionsOptions |
Options for querying history executions
|
| GetHistoryOrdersOptions |
Options for querying history orders
|
| GetStatementListOptions |
Options for querying statement list
|
| GetStockPositionsOptions |
Options for querying stock positions
|
| GetTodayExecutionsOptions |
Options for querying today's executions
|
| GetTodayOrdersOptions |
Options for querying today's orders
|
| Granularity |
Granularity of historical market temperature data
|
| HistoryMarketTemperatureResponse |
Response for historical market temperature query
|
| HttpClient |
Longbridge OpenAPI HTTP client.
|
| IndexConstituents |
Constituent stocks of a market index with daily movement summary.
|
| IndustryPeerNode |
A node in the recursive industry peer chain.
|
| IndustryPeersOptions |
|
| IndustryPeersResponse |
|
| IndustryPeersTop |
Top-level industry info in the peers response.
|
| IndustryRankGroup |
A group of ranked industry items.
|
| IndustryRankItem |
One ranked industry item.
|
| IndustryRankOptions |
|
| IndustryRankResponse |
|
| IndustryValuationDist |
Valuation ratio distributions for an industry, used for percentile ranking.
|
| IndustryValuationHistory |
Historical valuation snapshot for an industry peer.
|
| IndustryValuationItem |
Valuation data for one peer security within an industry.
|
| IndustryValuationList |
List of peer securities with their valuation data for an industry comparison.
|
| InstitutionRating |
Combined analyst-rating response for a security.
|
| InstitutionRatingDetail |
Detailed historical analyst rating data for a security.
|
| InstitutionRatingDetailEvaluate |
Historical rating distribution time-series for a security.
|
| InstitutionRatingDetailEvaluateItem |
One weekly analyst rating distribution snapshot.
|
| InstitutionRatingDetailTarget |
Historical analyst target price time-series for a security.
|
| InstitutionRatingDetailTargetItem |
One weekly analyst target price snapshot.
|
| InstitutionRatingLatest |
Latest analyst-rating snapshot for a security.
|
| InstitutionRatingSummary |
Consensus analyst-rating summary for a security.
|
| InstitutionRatingViewItem |
One historical rating distribution snapshot.
|
| InstitutionRatingViews |
|
| InstitutionRecommend |
Institutional analyst recommendation.
|
| IntradayLine |
Intraday line data point.
|
| InvestRelations |
Securities in which the queried company holds a stake.
|
| InvestSecurity |
A security in which the queried company has an investment stake.
|
| IssuerInfo |
Warrant issuer information.
|
| Language |
Language identifer
|
| MarginRatio |
Margin ratio information
|
| Market |
Market
|
| MarketContext |
Market data context — broker holdings, A/H premium, trade statistics,
market anomalies, index constituents and more.
|
| MarketStatusResponse |
Trading status response for one or more markets.
|
| MarketTemperature |
Market temperature data point.
|
| MarketTimeItem |
Trading status for one market.
|
| MarketTradingDays |
Market trading days for a given date range.
|
| MarketTradingSession |
Trading sessions for a single market on a given day.
|
| MyTopicsOptions |
Options for listing topics created by the current authenticated user
|
| NewsItem |
News item
|
| OAuth |
OAuth 2.0 client handle for Longbridge OpenAPI
|
| OAuthBuilder |
Builder for constructing an OAuth client
|
| OpenApiException |
Exception thrown by the Longbridge OpenAPI SDK.
|
| OperatingFinancial |
Key financial metrics extracted from an operating report.
|
| OperatingIndicator |
One financial indicator in an operating report.
|
| OperatingItem |
One operating summary report (annual or quarterly).
|
| OperatingList |
Response containing operating summary reports for a security.
|
| OptionDirection |
Option direction
|
| OptionQuote |
Quote of an option security.
|
| OptionType |
Option type
|
| OptionVolumeDaily |
|
| OptionVolumeDailyOptions |
|
| OptionVolumeDailyStat |
|
| OptionVolumeStats |
|
| Order |
Order information
|
| OrderChangedHandler |
Callback interface for order change push events
|
| OrderChargeDetail |
Order charge detail
|
| OrderChargeFee |
A single fee item in an order charge
|
| OrderChargeItem |
A charge item category in an order charge detail
|
| OrderDetail |
Detailed order information
|
| OrderHistoryDetail |
A single entry in the order history
|
| OrderSide |
Order side
|
| OrderStatus |
Order status
|
| OrderTag |
Order tag
|
| OrderType |
Order type
|
| OutsideRTH |
Whether the order is allowed to be traded outside regular trading hours
|
| OwnedTopic |
Topic created by the current authenticated user
|
| ParticipantInfo |
Market participant (broker) information.
|
| Period |
Candlestick period
|
| PinnedMode |
|
| PortfolioContext |
Portfolio analytics context — exchange rates, P&L analysis.
|
| PrePostQuote |
Quote of US pre/post market.
|
| Professional |
One executive or board member of a company.
|
| ProfitAnalysis |
|
| ProfitAnalysisByMarket |
|
| ProfitAnalysisByMarketItem |
One security entry in a by-market P&L response.
|
| ProfitAnalysisByMarketOptions |
|
| ProfitAnalysisDetail |
|
| ProfitAnalysisDetailOptions |
|
| ProfitAnalysisFlowsOptions |
|
| ProfitAnalysisFlowsResponse |
|
| ProfitAnalysisItem |
P&L for one security.
|
| ProfitAnalysisOptions |
|
| ProfitAnalysisSublist |
Per-security P&L breakdown.
|
| ProfitAnalysisSummary |
Account-level P&L summary.
|
| ProfitDetailEntry |
One P&L detail line item (credit, debit, or fee).
|
| ProfitDetails |
Detailed P&L breakdown for one asset class.
|
| ProfitSummaryBreakdown |
P&L breakdown by asset type.
|
| ProfitSummaryInfo |
P&L summary for one asset category.
|
| PushBrokers |
Real-time broker queue push event.
|
| PushCandlestick |
Real-time candlestick push event.
|
| PushCandlestickMode |
Push candlestick mode
|
| PushDepth |
Real-time order book depth push event.
|
| PushOrderChanged |
Real-time order change push event
|
| PushQuote |
Real-time quote push event.
|
| PushTrades |
Real-time trades push event.
|
| QueryWarrantOptions |
Query options for warrant list search
|
| QuoteContext |
Quote context
|
| QuoteHandler |
Callback interface for real-time quote push events
|
| QuotePackageDetail |
Quote package subscription detail.
|
| RankCategoriesResponse |
|
| RankListItem |
One item in the popularity rank list.
|
| RankListOptions |
|
| RankListResponse |
|
| RatingCategory |
One rating category (e.g. growth, profitability) for StockRatings.
|
| RatingEvaluate |
Analyst rating distribution counts for a security.
|
| RatingIndicator |
|
| RatingLeafIndicator |
|
| RatingSubIndicatorGroup |
A group of sub-indicators under one category indicator for RatingCategory.
|
| RatingSummaryEvaluate |
Simplified analyst rating distribution for the consensus summary.
|
| RatingTarget |
Analyst target price range for a security.
|
| RealtimeQuote |
Real-time quote retrieved from the local subscription cache.
|
| RecentBuybacks |
|
| ReplaceOrderOptions |
Options for replacing an order
|
| ScreenerContext |
Screener context — stock screener strategies, search, and indicator metadata.
|
| ScreenerIndicatorsResponse |
Response for screener indicators list.
|
| ScreenerRecommendStrategiesResponse |
|
| ScreenerSearchOptions |
|
| ScreenerSearchResponse |
Response for screener search.
|
| ScreenerStrategyOptions |
|
| ScreenerStrategyResponse |
Response for screener strategy detail.
|
| ScreenerUserStrategiesResponse |
|
| SecuritiesUpdateMode |
Securities update mode for watchlist groups
|
| Security |
Security basic information.
|
| SecurityBoard |
Security board
|
| SecurityBrokers |
Security broker queue (ask and bid sides).
|
| SecurityCalcIndex |
Calculated indexes for a security.
|
| SecurityDepth |
Security order book depth (ask and bid sides).
|
| SecurityListCategory |
Security list category
|
| SecurityQuote |
Quote of a security.
|
| SecurityStaticInfo |
Basic (static) information of a security.
|
| Shareholder |
One major shareholder of a security.
|
| ShareholderDetailOptions |
|
| ShareholderDetailResponse |
|
| ShareholderList |
Response containing major shareholders of a security.
|
| ShareholderStock |
A security in an institutional shareholder's cross-holdings.
|
| ShareholderTopResponse |
|
| SharelistContext |
Community sharelist management context.
|
| SharelistDetail |
|
| SharelistInfo |
Sharelist information.
|
| SharelistList |
|
| SharelistScopes |
Sharelist subscription scopes.
|
| SharelistStock |
Stock in a sharelist.
|
| ShortPosition |
|
| ShortPositionsItem |
One short-position record, unified for US and HK markets.
|
| ShortPositionsResponse |
|
| ShortTradesItem |
One short-trade record, unified for US and HK markets.
|
| ShortTradesOptions |
|
| ShortTradesResponse |
|
| SnapshotForecastMetric |
A forecast metric in the financial report snapshot.
|
| SnapshotReportedMetric |
A reported metric in the financial report snapshot.
|
| SortOrderType |
Sort order type
|
| StockPosition |
Stock position
|
| StockPositionChannel |
Stock positions grouped by account channel
|
| StockPositionsResponse |
Response containing all stock positions
|
| StockRatings |
|
| StrikePriceInfo |
Strike price information for an option chain.
|
| SubFlags |
|
| SubmitOrderOptions |
Options for submitting an order
|
| SubmitOrderResponse |
Response from submitting an order
|
| Subscription |
Active subscription for a security.
|
| TimeInForceType |
Order time-in-force type
|
| TopicAuthor |
Topic author
|
| TopicImage |
Topic image
|
| TopicItem |
Topic item
|
| TopicType |
Trade push topic type
|
| TopMoversEvent |
One top-movers event.
|
| TopMoversOptions |
|
| TopMoversResponse |
|
| TopMoversStock |
Stock information in a top-movers event.
|
| Trade |
A single trade tick.
|
| TradeContext |
Trade context
|
| TradeDirection |
Trade direction
|
| TradePriceLevel |
Trade volume at one price level.
|
| TradeSession |
Trade session
|
| TradeSessions |
Trade sessions filter for candlestick and intraday queries
|
| TradesHandler |
Callback interface for real-time trades push events
|
| TradeStatistics |
Summary trade statistics for a security.
|
| TradeStatsResponse |
Trade statistics response including summary and per-price-level breakdown.
|
| TradeStatus |
Security trading status
|
| TradingSessionInfo |
Time range of a single trading session.
|
| TriggerStatus |
Conditional order trigger status
|
| UpdatePinnedRequest |
|
| UpdateWatchlistGroup |
Request object for updating a watchlist group
|
| ValuationComparisonItem |
One security in the valuation comparison.
|
| ValuationComparisonOptions |
|
| ValuationComparisonResponse |
|
| ValuationData |
Valuation data response for a security.
|
| ValuationDist |
Distribution statistics for one valuation metric within an industry.
|
| ValuationHistoryData |
Container for historical valuation metrics.
|
| ValuationHistoryMetric |
Historical data for one valuation metric including statistical bounds.
|
| ValuationHistoryMetrics |
Historical valuation metrics container (PE / PB / PS).
|
| ValuationHistoryPoint |
One historical valuation data point.
|
| ValuationHistoryResponse |
Historical valuation response for a security.
|
| ValuationMetricData |
Historical time-series for one valuation metric.
|
| ValuationMetricsData |
Container for all valuation metrics (PE / PB / PS / dividend yield).
|
| ValuationPoint |
One valuation data point in a historical time-series.
|
| WarrantInfo |
Warrant information from the warrant list.
|
| WarrantQuote |
Quote of a warrant security.
|
| WarrantSortBy |
Warrant sort field
|
| WarrantStatus |
Warrant status
|
| WarrantType |
Warrant type
|
| WatchlistGroup |
Watchlist group.
|
| WatchlistSecurity |
A security in a watchlist group.
|