78 inline SubFlags(uint8_t value) { value_ = value; }
80 inline operator uint8_t()
const {
return value_; }
84 return SubFlags(value_ | other.value_);
89 value_ |= other.value_;
95 return SubFlags(value_ & other.value_);
100 value_ &= other.value_;
106 return value_ == other.value_;
111 return (value_ & other.value_) > 0;
870 std::optional<std::string>
name;
1343 std::vector<ShortPositionsItem>
data;
1398 std::vector<OptionVolumeDailyStat>
stats;
1759 std::vector<MultiLegOrderLeg>
legs;
1894 std::optional<std::vector<OrderStatus>>
status;
1911 std::optional<std::vector<OrderStatus>>
status;
2026 std::vector<SubmitMultiLegOrderLeg>
legs;
3264 std::vector<BrokerHoldingEntry>
buy;
3265 std::vector<BrokerHoldingEntry>
sell;
3292 std::vector<BrokerHoldingDetailItem>
list;
3308 std::vector<BrokerHoldingDailyItem>
list;
3503 namespace fundamental {
3674 std::optional<ValuationMetricData>
pe;
3675 std::optional<ValuationMetricData>
pb;
3676 std::optional<ValuationMetricData>
ps;
3689 std::optional<ValuationMetricData>
pe;
3690 std::optional<ValuationMetricData>
pb;
3691 std::optional<ValuationMetricData>
ps;
3912 std::vector<IndustryValuationItem>
list;
3930 std::optional<ValuationDist>
pe;
3931 std::optional<ValuationDist>
pb;
3932 std::optional<ValuationDist>
ps;
4101 std::vector<InstitutionRatingViewItem>
elist;
4152 std::optional<IndustryPeersTop>
top;
4183 std::optional<SnapshotForecastMetric>
fo_eps;
4231 std::vector<ValuationComparisonItem>
list;
4298 std::vector<AssetAllocationGroup>
info;
4516 namespace sharelist {
Definition: decimal.hpp:13
Subscription flags.
Definition: types.hpp:73
bool operator==(const SubFlags &other) const
Definition: types.hpp:104
SubFlags(uint8_t value)
Definition: types.hpp:78
SubFlags & operator|=(const SubFlags &other)
Definition: types.hpp:87
SubFlags operator&(const SubFlags &other) const
Definition: types.hpp:93
bool contains(const SubFlags &other) const
Definition: types.hpp:109
SubFlags operator|(const SubFlags &other) const
Definition: types.hpp:82
SubFlags & operator&=(const SubFlags &other)
Definition: types.hpp:98
ConversationStatus
Final run status of a conversation.
Definition: types.hpp:4755
@ Interrupted
The run is paused, waiting for AgentContext::continue_conversation.
@ Succeeded
The run completed successfully.
@ Stopped
The run was stopped.
ConversationStreamEventKind
Definition: types.hpp:5207
@ HumanInteractionRequired
@ Message
An incremental piece of the answer; message is populated.
@ ContextCompressFinished
@ ThinkingFinished
The reasoning phase is over; thinking_finished is populated.
@ ChatStarted
The run has started; chat_started is populated.
DCAStatus
DCA plan status.
Definition: types.hpp:4381
DCAFrequency
DCA investment frequency.
Definition: types.hpp:4372
InstitutionRecommend
Institutional analyst recommendation.
Definition: types.hpp:3507
ElementType
ETF asset allocation element type.
Definition: types.hpp:4236
TriggerPriceType
How grid trigger thresholds are interpreted (wire: int32_t).
Definition: types.hpp:2489
@ Spread
Trigger by absolute price spread.
@ Unknown
Unknown / unset.
@ Percent
Trigger by percent.
GridTimeInForce
Definition: types.hpp:2501
@ GoodTilDate
Good-til-date.
@ GoodTilCanceled
Good-til-canceled.
GridLimitEvent
Action taken when a grid boundary is reached (wire: int32_t).
Definition: types.hpp:2512
@ CloseAtLast
Close the position at the last price.
@ Unknown
Unknown / unset.
@ Ignore
Ignore — keep the grid running.
WarrantSortBy
Warrant sort by.
Definition: types.hpp:1091
@ LeverageRatio
Leverage ratio.
@ LowerStrikePrice
Lower strike price.
@ EffectiveLeverage
Effective leverage.
@ ConversionRatio
Conversion ratio.
@ ItmOtm
In/out of the bound.
@ StrikePrice
Strike price.
@ BalancePoint
Breakeven point.
@ ToCallPrice
Price interval from the call price.
@ ChangeValue
Change value.
@ ImpliedVolatility
Implied volatility.
@ Delta
Greek value Delta.
@ OutstandingRatio
Outstanding ratio.
@ OutstandingQuantity
Outstanding quantity.
@ UpperStrikePrice
Upper strike price.
TradeSessions
Trade sessions.
Definition: types.hpp:1255
SecuritiesUpdateMode
Securities update mode.
Definition: types.hpp:846
OptionDirection
Option direction.
Definition: types.hpp:467
Period
Candlestick period.
Definition: types.hpp:131
@ Min45
Forty-Five Minutes.
TradeSession
Trade session.
Definition: types.hpp:185
SecurityBoard
Security board.
Definition: types.hpp:270
@ STI
Singapore Straits Index.
@ USSector
US Industry Board.
@ HKPreIPO
HK PreIPO Security.
@ SHSTAR
SH Science and Technology Innovation Board.
@ SZMainNonConnect
SZ Main Board(Non Connect)
@ HKSector
HK Industry Board.
@ SZGEMNonConnect
SZ Gem Board(Non Connect)
@ SZMainConnect
SZ Main Board(Connect)
@ SHMainNonConnect
SH Main Board(Non Connect)
@ SHMainConnect
SH Main Board(Connect)
@ SZGEMConnect
SZ Gem Board(Connect)
@ USOptionS
US Sepecial Option.
@ SGSector
SG Industry Board.
@ HKEquity
Hong Kong Equity Securities.
@ USDJI
Dow Jones Industrial Average.
@ VIXIndex
CBOE Volatility Index.
@ CNSector
CN Industry Board.
FilterWarrantInOutBoundsType
Filter warrant in/out of the bounds type.
Definition: types.hpp:1153
TradeStatus
Trade status.
Definition: types.hpp:379
@ PrepareList
Papare List.
@ ToBeOpened
To Be Opened.
@ SplitStockHalts
Split Stock Halts.
@ WarrantPrepareList
Warrant To BeListed.
AdjustType
Adjust type.
Definition: types.hpp:717
OptionStandardAttr
Definition: types.hpp:492
@ Normal
A normal, active contract.
@ Old
A legacy contract produced by a corporate action.
TradeDirection
Trade direction.
Definition: types.hpp:547
WarrantType
Warrant type.
Definition: types.hpp:612
Granularity
Data granularity.
Definition: types.hpp:1279
@ Unknown
Unknown.
Definition: types.hpp:1281
@ Monthly
Monthly.
Definition: types.hpp:1287
@ Weekly
Weekly.
Definition: types.hpp:1285
@ Daily
Daily.
Definition: types.hpp:1283
SecurityListCategory
Security list category.
Definition: types.hpp:1233
WarrantStatus
Warrant status.
Definition: types.hpp:1162
@ PrepareList
Prepare List.
CalcIndex
Calc index.
Definition: types.hpp:902
@ OutstandingQty
Outstanding quantity.
@ TenDayChangeRate
Ten days change ratio.
@ LeverageRatio
Leverage ratio.
@ LowerStrikePrice
Lower bound price.
@ EffectiveLeverage
Effective leverage.
@ ConversionRatio
Conversion ratio.
@ WarrantDelta
Warrant delta.
@ DividendRatioTtm
Dividend ratio (TTM)
@ ItmOtm
In/out of the bound.
@ CapitalFlow
Capital flow.
@ YtdChangeRate
Year-to-date change ratio.
@ FiveDayChangeRate
Five days change ratio.
@ StrikePrice
Strike price.
@ BalancePoint
Breakeven point.
@ ToCallPrice
Price interval from the call price.
@ TotalMarketValue
Total market value.
@ ChangeValue
Change value.
@ HalfYearChangeRate
Half year change ratio.
@ TurnoverRate
Turnover rate.
@ ImpliedVolatility
Implied volatility.
@ OutstandingRatio
Outstanding ratio.
@ FiveMinutesChangeRate
Five minutes change ratio.
@ UpperStrikePrice
Upper bound price.
@ VolumeRatio
Volume ratio.
@ OpenInterest
Open interest.
OptionExpiryCycleType
Special expiration cycle of an option contract.
Definition: types.hpp:478
@ Quarterly
Quarterly option, expires quarterly.
SortOrderType
Sort order type.
Definition: types.hpp:1082
OptionType
Option type.
Definition: types.hpp:456
FilterWarrantExpiryDate
Filter warrant expiry date type.
Definition: types.hpp:1140
@ Between_6_12
6 - 12 months
@ Between_3_6
3 - 6 months
@ GT_12
Greater than 12 months.
@ LT_3
Less than 3 months.
ContractDirection
Option contract type.
Definition: types.hpp:1719
OrderTag
Order tag.
Definition: types.hpp:1556
@ LongTerm
Long term Order.
CashFlowDirection
Cash flow direction.
Definition: types.hpp:2090
OutsideRTH
Enable or disable outside regular trading hours.
Definition: types.hpp:1595
@ RTHOnly
Regular trading hour only.
@ OptionPreMarket
Overnight option.
TriggerStatus
Trigger status.
Definition: types.hpp:1582
TopicType
Topic type.
Definition: types.hpp:1407
@ Private
Private notification for trade.
BalanceType
Balance type.
Definition: types.hpp:2101
DeductionStatus
Deduction status.
Definition: types.hpp:2260
AttachedOrderType
Attached order type.
Definition: types.hpp:1610
@ ProfitTaker
Take profit.
OrderSide
Order side.
Definition: types.hpp:1414
CommissionFreeStatus
Commission-free Status.
Definition: types.hpp:2250
ChargeCategoryCode
Charge category code.
Definition: types.hpp:2270
OrderStatus
Order status.
Definition: types.hpp:1482
@ PartialWithdrawal
Partial Withdrawal.
@ ReplacedNotReported
Not reported (Replaced Order)
@ PendingCancel
Pending Cancel.
@ WaitToReplace
Wait To Replace.
@ PartialFilled
Partial Filled.
@ PendingReplace
Pending Replace.
@ VarietiesNotReported
Not reported (Conditional Order)
@ NotReported
Not reported.
@ WaitToCancel
Wait To Cancel.
@ ProtectedNotReported
Not reported (Protected Order)
OrderType
Order type.
Definition: types.hpp:1523
@ TSLPAMT
Trailing Limit If Touched (Trailing Amount)
@ ALO
At-auction Limit Order.
@ SLO
Special Limit Order.
@ TSMAMT
Trailing Market If Touched (Trailing Amount)
@ ELO
Enhanced Limit Order.
@ TSLPPCT
Trailing Limit If Touched (Trailing Percent)
@ TSMPCT
Trailing Market If Touched (Trailing Percent)
MultiLegPosition
Multi-leg position direction.
Definition: types.hpp:1708
MultiLegStrategy
Multi-leg strategy.
Definition: types.hpp:1683
@ CoveredPut
Covered put (covered stock)
@ VerticalCallSpread
Vertical call spread.
@ CalendarCallSpread
Calendar call spread.
@ CalendarPutSpread
Calendar put spread.
@ VerticalPutSpread
Vertical put spread.
@ CoveredCall
Covered call (covered stock)
TimeInForceType
Time in force Type.
Definition: types.hpp:1569
@ GoodTilDate
Good Til Date Order.
@ GoodTilCanceled
Good Til Canceled Order.
Definition: agent_context.hpp:13
PushCandlestickMode
Push candlestick mode.
Definition: types.hpp:43
Market
Market.
Definition: types.hpp:52
Language
Language identifer.
Definition: types.hpp:32
uint8_t day
Definition: types.hpp:14
uint8_t month
Definition: types.hpp:13
int32_t year
Definition: types.hpp:12
Time time
Definition: types.hpp:27
Date date
Definition: types.hpp:26
uint8_t second
Definition: types.hpp:21
uint8_t minute
Definition: types.hpp:20
uint8_t hour
Definition: types.hpp:19
Present when a conversation run failed.
Definition: types.hpp:4746
int32_t code
Error code.
Definition: types.hpp:4748
std::string message
Error message.
Definition: types.hpp:4750
An Agent in a Workspace.
Definition: types.hpp:4629
int64_t created_at
Creation time, Unix timestamp in seconds.
Definition: types.hpp:4645
int64_t published_at
Publish time, Unix timestamp in seconds; 0 if unpublished.
Definition: types.hpp:4643
bool is_published
Whether published; only published Agents can start conversations.
Definition: types.hpp:4641
std::string mode
Agent mode, e.g. "chat".
Definition: types.hpp:4637
std::string icon
Icon URL.
Definition: types.hpp:4639
int64_t updated_at
Last updated time, Unix timestamp in seconds.
Definition: types.hpp:4647
std::string description
Agent description.
Definition: types.hpp:4635
std::string uid
Agent UID, used as the path parameter of AgentContext::conversation.
Definition: types.hpp:4631
std::string name
Agent name.
Definition: types.hpp:4633
Response for AgentContext::agents.
Definition: types.hpp:4652
int32_t total
Total number of matching Agents.
Definition: types.hpp:4656
std::vector< Agent > agents
Agent list.
Definition: types.hpp:4654
Definition: types.hpp:5173
std::string error
Empty string in every run observed so far.
Definition: types.hpp:5181
std::string chat_uid
Conversation identifier.
Definition: types.hpp:5177
std::string error_message
Empty string in every run observed so far.
Definition: types.hpp:5183
std::string message_id
Message ID of this round.
Definition: types.hpp:5179
int64_t chat_id
ID of the owning conversation.
Definition: types.hpp:5175
Payload of a ChatStarted conversation stream event.
Definition: types.hpp:4793
std::string chat_uid
Conversation identifier.
Definition: types.hpp:4795
std::string error_message
Error message; empty when absent.
Definition: types.hpp:4803
std::string message_id
Message ID of this round.
Definition: types.hpp:4799
int64_t chat_id
Numeric conversation identifier.
Definition: types.hpp:4797
std::string error
Error code; empty when absent.
Definition: types.hpp:4801
Definition: types.hpp:5191
std::string title
The new (possibly truncated) title.
Definition: types.hpp:5199
int64_t chat_id
ID of the owning conversation.
Definition: types.hpp:5193
std::string source
Where the title came from, e.g. "ai_generated".
Definition: types.hpp:5197
std::string chat_uid
Conversation identifier.
Definition: types.hpp:5195
int64_t updated_at
Unix timestamp in seconds.
Definition: types.hpp:5201
Definition: types.hpp:5160
std::string inputs_json
Compression input summary, as a JSON string; empty when absent.
Definition: types.hpp:5164
std::string created_at
Finish time, RFC 3339.
Definition: types.hpp:5162
std::string outputs_json
Compression result summary, as a JSON string; empty when absent.
Definition: types.hpp:5166
Definition: types.hpp:5150
std::string started_at
Start time, RFC 3339.
Definition: types.hpp:5152
std::string inputs_json
Compression input summary, as a JSON string; empty when absent.
Definition: types.hpp:5154
Definition: types.hpp:4769
std::string chat_uid
Definition: types.hpp:4772
std::optional< Interrupt > interrupt
Present only when status is ConversationStatus::Interrupted.
Definition: types.hpp:4786
ConversationStatus status
Final run status.
Definition: types.hpp:4776
std::vector< Reference > references
Sources referenced by the answer.
Definition: types.hpp:4780
double elapsed_time
Run duration in seconds.
Definition: types.hpp:4784
std::string message_id
Message ID of this round.
Definition: types.hpp:4774
std::vector< std::string > further_questions
Suggested follow-up questions ("you might also ask"); empty when absent.
Definition: types.hpp:4782
std::optional< AgentError > error
Present only when the run failed.
Definition: types.hpp:4788
std::string answer
Final answer text; valid when status is ConversationStatus::Succeeded.
Definition: types.hpp:4778
Definition: types.hpp:5290
ConversationStreamEventKind kind
Discriminant, tells you which field below is populated.
Definition: types.hpp:5292
std::optional< NodeToolUseFinishedPayload > node_tool_use_finished
Definition: types.hpp:5311
std::optional< ThinkingStartedPayload > thinking_started
Definition: types.hpp:5302
std::optional< ConversationResponse > workflow_finished
Definition: types.hpp:5355
std::optional< ConversationResponse > human_interaction_required
Definition: types.hpp:5334
std::optional< AgentToolProgressPayload > agent_tool_progress
Definition: types.hpp:5326
std::optional< WorkflowStartedPayload > workflow_started
Definition: types.hpp:5297
std::optional< ChatStartedPayload > chat_started
Populated when kind is ChatStarted
Definition: types.hpp:5294
std::optional< SubagentStartedPayload > subagent_started
Definition: types.hpp:5314
std::optional< ContextCompressStartedPayload > context_compress_started
Definition: types.hpp:5343
std::optional< NodeToolUseStartedPayload > node_tool_use_started
Definition: types.hpp:5308
std::optional< PlanChangedPayload > plan_changed
Definition: types.hpp:5340
std::optional< ThinkingFinishedPayload > thinking_finished
Definition: types.hpp:5305
std::optional< MessagePayload > message
Populated when kind is Message
Definition: types.hpp:5299
std::optional< std::string > other_json
Definition: types.hpp:5364
std::optional< SubagentProgressPayload > subagent_progress
Definition: types.hpp:5317
std::optional< AgentToolStartedPayload > agent_tool_started
Definition: types.hpp:5323
std::optional< std::string > other_event
Definition: types.hpp:5361
std::optional< ContextCompressFinishedPayload > context_compress_finished
Definition: types.hpp:5346
std::optional< AgentToolFinishedPayload > agent_tool_finished
Definition: types.hpp:5329
std::optional< ChatTitleUpdatedPayload > chat_title_updated
Definition: types.hpp:5358
std::optional< ChatFinishedPayload > chat_finished
Definition: types.hpp:5349
std::optional< QueryMaskedPayload > query_masked
Definition: types.hpp:5337
std::optional< SubagentFinishedPayload > subagent_finished
Definition: types.hpp:5320
Options for AgentContext::agents (all fields optional).
Definition: types.hpp:4661
std::optional< int32_t > page
Page number, starts at 1.
Definition: types.hpp:4663
std::optional< int32_t > limit
Page size.
Definition: types.hpp:4665
std::optional< std::string > name
Fuzzy search by Agent name.
Definition: types.hpp:4667
A single interaction requested while an Agent workflow is paused.
Definition: types.hpp:4711
std::string interaction_type
Interaction type such as ask_human or trade_password
Definition: types.hpp:4717
std::string tool_args_json
Original tool arguments as a JSON string; empty when absent.
Definition: types.hpp:4723
std::string tool_call_id
Tool call that requested the interaction.
Definition: types.hpp:4713
std::string tool_name
Human-readable tool name.
Definition: types.hpp:4719
std::vector< Question > questions
Questions and answer options presented to the user.
Definition: types.hpp:4721
std::string interrupt_id
Stable key expected by the answers map when continuing.
Definition: types.hpp:4715
Definition: types.hpp:4729
int64_t chat_id
ID of the owning conversation.
Definition: types.hpp:4741
std::string tool_call_id
Tool call ID of this inquiry; used as the answer key when continuing.
Definition: types.hpp:4733
int64_t message_id
ID of the paused message.
Definition: types.hpp:4739
std::vector< HumanInteraction > interactions
Full interaction descriptors used to render and answer the pause.
Definition: types.hpp:4737
std::string node_id
ID of the node that triggered the interrupt.
Definition: types.hpp:4731
std::vector< Question > questions
Questions you need to answer.
Definition: types.hpp:4735
Definition: types.hpp:4810
std::string stage_title
Definition: types.hpp:4826
std::string outputs_json
Definition: types.hpp:4832
std::string stage_finished_title
Definition: types.hpp:4829
std::string message_type
Definition: types.hpp:4815
std::string stage
Stage identifier; only present when message_type is "process".
Definition: types.hpp:4823
std::string text
Incremental text fragment.
Definition: types.hpp:4812
std::string key
Definition: types.hpp:4819
int64_t started_at
Time this segment started, Unix timestamp in seconds.
Definition: types.hpp:4821
Definition: types.hpp:5134
std::string outputs_json
The current plan content, as a JSON string; empty when absent.
Definition: types.hpp:5140
std::string tool_name
Identifies the planning tool.
Definition: types.hpp:5142
int64_t started_at
Time of the change, Unix timestamp in seconds.
Definition: types.hpp:5138
std::string node_id
ID of the planning node.
Definition: types.hpp:5136
Definition: types.hpp:5124
std::string masked_query
The masked query.
Definition: types.hpp:5128
std::string raw_query
The original user query.
Definition: types.hpp:5126
One question the Agent needs you to answer.
Definition: types.hpp:4700
bool multi_select
Whether multiple options may be selected.
Definition: types.hpp:4706
std::string question
Question text.
Definition: types.hpp:4702
std::vector< QuestionOption > options
Options; empty means free-form answer.
Definition: types.hpp:4704
One option of a Question.
Definition: types.hpp:4691
std::string description
Option text.
Definition: types.hpp:4695
std::string label
Short UI label for the option.
Definition: types.hpp:4693
A source referenced by the answer.
Definition: types.hpp:4672
int32_t original_index
Original reference index as provided by the source.
Definition: types.hpp:4676
std::string content_json
Full nested reference payload, as a JSON string; empty when absent.
Definition: types.hpp:4686
std::string title
Reference title.
Definition: types.hpp:4682
std::string ref_type
Reference type (wire field type)
Definition: types.hpp:4678
std::string id
Reference identifier.
Definition: types.hpp:4680
int32_t index
Reference index.
Definition: types.hpp:4674
std::string url
Reference URL.
Definition: types.hpp:4684
Payload of a SubagentFinished conversation stream event.
Definition: types.hpp:5021
std::string status
succeeded / failed
Definition: types.hpp:5027
std::string node_id
ID of the node that spawned the subagent.
Definition: types.hpp:5023
SubagentOutputs outputs
Subagent result: goal, result, and the timeline of tool calls it made.
Definition: types.hpp:5035
std::string error
Error description on failure.
Definition: types.hpp:5033
std::string tool_use_id
Matches the tool_use_id of SubagentStarted.
Definition: types.hpp:5025
double elapsed_time
Total subagent duration in seconds.
Definition: types.hpp:5031
int64_t started_at
Start time, Unix timestamp in seconds.
Definition: types.hpp:5029
outputs of a SubagentFinished conversation stream event.
Definition: types.hpp:5009
std::string result
The subagent's result; empty when absent.
Definition: types.hpp:5013
std::string goal
The goal that was assigned to the subagent; empty when absent.
Definition: types.hpp:5011
std::string subagent_tools_json
Definition: types.hpp:5016
Definition: types.hpp:4988
std::string subagent_tool_name
Name of the tool the subagent called.
Definition: types.hpp:4994
std::string subagent_status
Status of that call: running / succeeded / failed.
Definition: types.hpp:4998
std::string subagent_tool_args
Arguments of that call, as a JSON string.
Definition: types.hpp:4996
int32_t subagent_iteration
The subagent's internal round number.
Definition: types.hpp:5002
std::string node_id
ID of the node that spawned the subagent.
Definition: types.hpp:4990
int64_t started_at
Start time, Unix timestamp in seconds.
Definition: types.hpp:5004
std::string parent_tool_call_id
tool_use_id of the owning SubagentStarted event
Definition: types.hpp:4992
int64_t subagent_duration_ms
Duration of that call in milliseconds.
Definition: types.hpp:5000
Definition: types.hpp:4966
std::string tool_use_id
Unique ID of this spawn; matches the finished event.
Definition: types.hpp:4970
int64_t started_at
Start time, Unix timestamp in seconds.
Definition: types.hpp:4972
std::string prompt
Full task prompt given to the subagent.
Definition: types.hpp:4976
std::string tools_json
Definition: types.hpp:4981
std::string subagent_id
Subagent identifier; may be empty.
Definition: types.hpp:4978
std::string goal
Goal assigned to the subagent.
Definition: types.hpp:4974
std::string node_id
ID of the node that spawned the subagent.
Definition: types.hpp:4968
Definition: types.hpp:4876
int32_t elapsed_time
Reasoning duration in seconds.
Definition: types.hpp:4880
int64_t finished_at
Finish time, Unix timestamp in seconds.
Definition: types.hpp:4878
Definition: types.hpp:4867
int64_t started_at
Start time, Unix timestamp in seconds.
Definition: types.hpp:4869
Definition: types.hpp:4851
int64_t workflow_id
Internal workflow run ID.
Definition: types.hpp:4859
int64_t started_at
Unix timestamp in seconds.
Definition: types.hpp:4857
WorkflowStartedInputs inputs
Echoes the run's inputs.
Definition: types.hpp:4855
bool hit_cache
Whether this run's answer was served from a cache.
Definition: types.hpp:4853
A Workspace the current account belongs to.
Definition: types.hpp:4609
std::string name
Workspace name.
Definition: types.hpp:4613
int64_t created_at
Creation time, Unix timestamp in seconds.
Definition: types.hpp:4615
std::string id
Workspace ID.
Definition: types.hpp:4611
int64_t updated_at
Last updated time, Unix timestamp in seconds.
Definition: types.hpp:4617
Response for AgentContext::workspaces.
Definition: types.hpp:4622
std::vector< Workspace > workspaces
Workspaces the current account belongs to.
Definition: types.hpp:4624
Definition: types.hpp:4317
int32_t scope
Scope.
Definition: types.hpp:4327
int32_t frequency
Trigger frequency: 1=daily, 2=every_time, 3=once.
Definition: types.hpp:4325
std::string id
Alert ID.
Definition: types.hpp:4319
std::string indicator_id
Condition: "1"=price_rise, "2"=price_fall, "3"=pct_rise, "4"=pct_fall.
Definition: types.hpp:4321
AlertValueMap value_map
Trigger threshold.
Definition: types.hpp:4333
bool enabled
Whether the alert is currently active.
Definition: types.hpp:4323
std::string text
Human-readable description of the trigger condition.
Definition: types.hpp:4329
std::vector< int32_t > state
Trigger state flags.
Definition: types.hpp:4331
Response for AlertContext::list — alerts grouped by security.
Definition: types.hpp:4361
std::vector< AlertSymbolGroup > lists
Alert groups, one per security.
Definition: types.hpp:4363
All price alerts for one security.
Definition: types.hpp:4338
std::string p_chg
Day change percentage.
Definition: types.hpp:4352
std::vector< AlertItem > indicators
Alert items for this security.
Definition: types.hpp:4356
std::string name
Security name.
Definition: types.hpp:4346
std::string code
Ticker code (without market)
Definition: types.hpp:4342
std::string market
Market, e.g. "HK".
Definition: types.hpp:4344
std::string chg
Day change amount.
Definition: types.hpp:4350
std::string price
Latest price.
Definition: types.hpp:4348
std::string product
Product type (may be empty)
Definition: types.hpp:4354
std::string symbol
Security symbol.
Definition: types.hpp:4340
Definition: types.hpp:4309
std::optional< double > chg
Percentage-change threshold (nullopt if not set)
Definition: types.hpp:4313
std::string price
Absolute price threshold as a decimal string (empty if not set)
Definition: types.hpp:4311
Options for creating a topic.
Definition: types.hpp:3216
std::vector< std::string > tickers
Related stock tickers, format: {symbol}.{market}, max 10.
Definition: types.hpp:3224
std::string body
Topic body in Markdown format (required)
Definition: types.hpp:3220
std::string title
Topic title (required)
Definition: types.hpp:3218
std::vector< std::string > hashtags
Hashtag names, max 5.
Definition: types.hpp:3226
std::string topic_type
Content type: "article" or "post" (empty = default "post")
Definition: types.hpp:3222
Options for listing topics created by the current authenticated user.
Definition: types.hpp:3205
int32_t page
Page number (0 = default 1)
Definition: types.hpp:3207
int32_t size
Records per page, range 1~500 (0 = default 50)
Definition: types.hpp:3209
std::string topic_type
Filter by content type: "article" or "post" (empty = all)
Definition: types.hpp:3211
News item.
Definition: types.hpp:3125
std::string title
Title.
Definition: types.hpp:3129
int32_t likes_count
Likes count.
Definition: types.hpp:3139
std::string url
URL.
Definition: types.hpp:3133
int32_t shares_count
Shares count.
Definition: types.hpp:3141
std::string description
Description.
Definition: types.hpp:3131
int32_t comments_count
Comments count.
Definition: types.hpp:3137
int64_t published_at
Published time (Unix timestamp)
Definition: types.hpp:3135
std::string id
News ID.
Definition: types.hpp:3127
My topic item (created by the current authenticated user)
Definition: types.hpp:3168
std::vector< std::string > hashtags
Hashtag names.
Definition: types.hpp:3182
int32_t comments_count
Comments count.
Definition: types.hpp:3188
std::string title
Title.
Definition: types.hpp:3172
int32_t views_count
Views count.
Definition: types.hpp:3190
std::string id
Topic ID.
Definition: types.hpp:3170
int64_t updated_at
Updated time (Unix timestamp)
Definition: types.hpp:3200
std::vector< std::string > tickers
Related stock tickers.
Definition: types.hpp:3180
int64_t created_at
Created time (Unix timestamp)
Definition: types.hpp:3198
std::string description
Plain text excerpt.
Definition: types.hpp:3174
int32_t shares_count
Shares count.
Definition: types.hpp:3192
std::vector< TopicImage > images
Images.
Definition: types.hpp:3184
int32_t likes_count
Likes count.
Definition: types.hpp:3186
std::string detail_url
URL to the full topic page.
Definition: types.hpp:3196
std::string topic_type
Content type: "article" or "post".
Definition: types.hpp:3194
TopicAuthor author
Author.
Definition: types.hpp:3178
std::string body
Markdown body.
Definition: types.hpp:3176
Topic author.
Definition: types.hpp:3146
std::string member_id
Member ID.
Definition: types.hpp:3148
std::string avatar
Avatar URL.
Definition: types.hpp:3152
std::string name
Display name.
Definition: types.hpp:3150
Topic image.
Definition: types.hpp:3157
std::string lg
Large image URL.
Definition: types.hpp:3163
std::string url
Original image URL.
Definition: types.hpp:3159
std::string sm
Small thumbnail URL.
Definition: types.hpp:3161
Topic item.
Definition: types.hpp:3104
std::string url
URL.
Definition: types.hpp:3112
int32_t likes_count
Likes count.
Definition: types.hpp:3118
std::string description
Description.
Definition: types.hpp:3110
std::string title
Title.
Definition: types.hpp:3108
int64_t published_at
Published time (Unix timestamp)
Definition: types.hpp:3114
int32_t shares_count
Shares count.
Definition: types.hpp:3120
std::string id
Topic ID.
Definition: types.hpp:3106
int32_t comments_count
Comments count.
Definition: types.hpp:3116
Response for DCAContext::calc_date — next projected trade date.
Definition: types.hpp:4480
std::string trade_date
Next projected trade date (unix timestamp string)
Definition: types.hpp:4482
Response for DCAContext::create_dca and DCAContext::update_dca.
Definition: types.hpp:4487
std::string plan_id
The plan ID of the created or updated DCA plan.
Definition: types.hpp:4489
One DCA execution history record.
Definition: types.hpp:4494
std::string order_id
Definition: types.hpp:4496
std::string action
Definition: types.hpp:4498
std::string order_type
Definition: types.hpp:4499
std::string created_at
Definition: types.hpp:4495
std::string rejected_reason
Definition: types.hpp:4503
std::string executed_price
Definition: types.hpp:4501
std::string executed_amount
Definition: types.hpp:4502
std::string symbol
Definition: types.hpp:4504
std::string executed_qty
Definition: types.hpp:4500
std::string status
Definition: types.hpp:4497
Paginated DCA execution history response.
Definition: types.hpp:4509
bool has_more
Definition: types.hpp:4511
std::vector< DcaHistoryRecord > records
Definition: types.hpp:4510
Response for DCAContext::list and write operations.
Definition: types.hpp:4438
std::vector< DcaPlan > plans
DCA plans.
Definition: types.hpp:4440
One DCA (dollar-cost averaging) investment plan.
Definition: types.hpp:4389
std::string updated_at
Last updated time.
Definition: types.hpp:4421
std::string average_cost
Average cost.
Definition: types.hpp:4431
DCAFrequency invest_frequency
Investment frequency.
Definition: types.hpp:4409
std::string aaid
Account ID.
Definition: types.hpp:4399
std::string next_trd_date
Next investment date.
Definition: types.hpp:4423
std::string cum_amount
Cumulative invested amount.
Definition: types.hpp:4427
std::string invest_day_of_week
Day of week for weekly plans (e.g. "Mon")
Definition: types.hpp:4411
std::string stock_name
Security name.
Definition: types.hpp:4425
std::string alter_hours
Advance reminder hours ("1", "6", or "12")
Definition: types.hpp:4417
bool allow_margin_finance
Whether margin finance is allowed.
Definition: types.hpp:4415
std::string symbol
Security symbol.
Definition: types.hpp:4395
DCAStatus status
Plan status.
Definition: types.hpp:4393
int64_t issue_number
Number of completed investment periods.
Definition: types.hpp:4429
std::string display_account
Display account.
Definition: types.hpp:4403
std::string plan_id
Plan ID.
Definition: types.hpp:4391
std::string created_at
Creation time.
Definition: types.hpp:4419
std::string account_channel
Account channel.
Definition: types.hpp:4401
std::string per_invest_amount
Investment amount per period.
Definition: types.hpp:4407
std::string invest_day_of_month
Day of month for monthly plans.
Definition: types.hpp:4413
std::string member_id
Member ID.
Definition: types.hpp:4397
std::string cum_profit
Cumulative profit/loss.
Definition: types.hpp:4433
longbridge::Market market
Market.
Definition: types.hpp:4405
Response for DCAContext::stats — aggregate DCA statistics.
Definition: types.hpp:4445
std::string suspended_count
Number of suspended plans.
Definition: types.hpp:4451
std::string finished_count
Number of finished plans.
Definition: types.hpp:4449
std::vector< DcaPlan > nearest_plans
Nearest upcoming plans.
Definition: types.hpp:4453
std::string active_count
Number of active plans.
Definition: types.hpp:4447
std::string total_amount
Total invested amount.
Definition: types.hpp:4457
std::string total_profit
Total profit/loss.
Definition: types.hpp:4459
std::string rest_days
Days until next investment.
Definition: types.hpp:4455
DCA support info for one security.
Definition: types.hpp:4464
std::string symbol
Security symbol.
Definition: types.hpp:4466
bool support_regular_saving
Whether DCA is supported for this security.
Definition: types.hpp:4468
Response for DCAContext::check_support.
Definition: types.hpp:4473
std::vector< DcaSupportInfo > infos
Support info per security.
Definition: types.hpp:4475
One ETF asset allocation group (grouped by element type)
Definition: types.hpp:4285
ElementType asset_type
Element type of this group.
Definition: types.hpp:4289
std::string report_date
Report date (e.g. 20260601)
Definition: types.hpp:4287
std::vector< AssetAllocationItem > lists
Elements.
Definition: types.hpp:4291
One element of an ETF asset allocation group.
Definition: types.hpp:4268
std::string symbol
Security symbol (holdings only, e.g. NVDA.US)
Definition: types.hpp:4276
std::string position_ratio
Position ratio (e.g. 0.0861114)
Definition: types.hpp:4274
std::optional< HoldingDetail > holding_detail
Holding detail (holdings only)
Definition: types.hpp:4280
std::string name
Element name.
Definition: types.hpp:4270
std::map< std::string, std::string > name_locales
Localized names (locale → name)
Definition: types.hpp:4278
std::string code
Security code (holdings only, e.g. NVDA)
Definition: types.hpp:4272
ETF asset allocation response.
Definition: types.hpp:4296
std::vector< AssetAllocationGroup > info
Asset allocation groups.
Definition: types.hpp:4298
One business/regional segment item in a historical snapshot.
Definition: types.hpp:4064
std::string percent
Definition: types.hpp:4066
std::string value
Definition: types.hpp:4067
std::string name
Definition: types.hpp:4065
One business segment item (latest snapshot).
Definition: types.hpp:4048
std::string percent
Definition: types.hpp:4050
std::string name
Definition: types.hpp:4049
One historical business segments snapshot.
Definition: types.hpp:4072
std::string date
Definition: types.hpp:4073
std::vector< BusinessSegmentHistoryItem > business
Definition: types.hpp:4076
std::string currency
Definition: types.hpp:4075
std::string total
Definition: types.hpp:4074
std::vector< BusinessSegmentHistoryItem > regionals
Definition: types.hpp:4077
Business segments history response.
Definition: types.hpp:4082
std::vector< BusinessSegmentsHistoricalItem > historical
Definition: types.hpp:4083
Business segments response.
Definition: types.hpp:4055
std::string currency
Definition: types.hpp:4058
std::vector< BusinessSegmentItem > business
Definition: types.hpp:4059
std::string total
Definition: types.hpp:4057
std::string date
Definition: types.hpp:4056
Buyback data response.
Definition: types.hpp:3991
std::vector< BuybackHistoryItem > buyback_history
Definition: types.hpp:3993
std::optional< RecentBuybacks > recent_buybacks
Definition: types.hpp:3992
std::vector< BuybackRatios > buyback_ratios
Definition: types.hpp:3994
Historical annual buyback data point.
Definition: types.hpp:3973
std::string fiscal_year_range
Definition: types.hpp:3975
std::string currency
Definition: types.hpp:3979
std::string net_buyback_growth_rate
Definition: types.hpp:3978
std::string fiscal_year
Definition: types.hpp:3974
std::string net_buyback_yield
Definition: types.hpp:3977
std::string net_buyback
Definition: types.hpp:3976
Buyback payout and cash-flow ratios.
Definition: types.hpp:3984
std::string net_buyback_to_cashflow_ratio
Definition: types.hpp:3986
std::string net_buyback_payout_ratio
Definition: types.hpp:3985
Company overview and profile information.
Definition: types.hpp:3696
std::string fax
Definition: types.hpp:3715
std::string founded
Definition: types.hpp:3699
std::string address
Definition: types.hpp:3703
std::string website
Definition: types.hpp:3705
std::string ticker
Definition: types.hpp:3719
std::string year_end
Definition: types.hpp:3712
std::string profile
Definition: types.hpp:3720
std::string audit_inst
Definition: types.hpp:3710
int32_t sector
Definition: types.hpp:3721
std::string listing_date
Definition: types.hpp:3700
std::string category
Definition: types.hpp:3711
std::string chairman
Definition: types.hpp:3708
std::string name
Definition: types.hpp:3697
std::string phone
Definition: types.hpp:3714
std::string email
Definition: types.hpp:3716
std::string issue_price
Definition: types.hpp:3706
std::string employees
Definition: types.hpp:3713
std::string manager
Definition: types.hpp:3718
std::string legal_repr
Definition: types.hpp:3717
std::string region
Definition: types.hpp:3702
std::string office_address
Definition: types.hpp:3704
std::string secretary
Definition: types.hpp:3709
std::string company_name
Definition: types.hpp:3698
std::string shares_offered
Definition: types.hpp:3707
std::string market
Definition: types.hpp:3701
One consensus estimate detail for a financial metric.
Definition: types.hpp:3852
std::string comp_desc
Definition: types.hpp:3859
std::string key
Definition: types.hpp:3853
std::string estimate
Definition: types.hpp:3857
std::string description
Definition: types.hpp:3855
std::string name
Definition: types.hpp:3854
std::string comp
Definition: types.hpp:3860
bool is_released
Definition: types.hpp:3861
std::string actual
Definition: types.hpp:3856
std::string comp_value
Definition: types.hpp:3858
Consensus report for one fiscal period.
Definition: types.hpp:3866
std::string period_text
Definition: types.hpp:3869
int32_t fiscal_year
Definition: types.hpp:3867
std::vector< ConsensusDetail > details
Definition: types.hpp:3870
std::string fiscal_period
Definition: types.hpp:3868
One corporate action event (dividend, split, etc.).
Definition: types.hpp:3772
std::string id
Definition: types.hpp:3773
bool is_delay
Definition: types.hpp:3782
std::string date_str
Definition: types.hpp:3775
std::string act_desc
Definition: types.hpp:3779
std::string date_zone
Definition: types.hpp:3777
std::string act_type
Definition: types.hpp:3778
bool recent
Definition: types.hpp:3781
std::string date_type
Definition: types.hpp:3776
std::string date
Definition: types.hpp:3774
std::string action
Definition: types.hpp:3780
std::string delay_content
Definition: types.hpp:3783
Collection of corporate action events.
Definition: types.hpp:3788
std::vector< CorpActionItem > items
Definition: types.hpp:3789
One dividend event for a security.
Definition: types.hpp:3519
std::string symbol
Definition: types.hpp:3520
std::string record_date
Definition: types.hpp:3523
std::string desc
Definition: types.hpp:3522
std::string ex_date
Definition: types.hpp:3524
std::string id
Definition: types.hpp:3521
std::string payment_date
Definition: types.hpp:3525
List of dividend events.
Definition: types.hpp:3530
std::vector< DividendItem > list
Definition: types.hpp:3531
Executives for one security.
Definition: types.hpp:3950
std::string symbol
Definition: types.hpp:3951
int32_t total
Definition: types.hpp:3953
std::vector< Professional > professionals
Definition: types.hpp:3954
std::string forward_url
Definition: types.hpp:3952
List of executive groups per security.
Definition: types.hpp:3959
std::vector< ExecutiveGroup > professional_list
Definition: types.hpp:3960
Financial consensus response.
Definition: types.hpp:3875
int32_t current_index
Definition: types.hpp:3877
std::string current_period
Definition: types.hpp:3880
std::vector< ConsensusReport > list
Definition: types.hpp:3876
std::string currency
Definition: types.hpp:3878
std::vector< std::string > opt_periods
Definition: types.hpp:3879
Financial report snapshot response.
Definition: types.hpp:4174
std::string fr_asset_turn_ttm
Definition: types.hpp:4194
std::optional< SnapshotForecastMetric > fo_ebit
Definition: types.hpp:4182
std::string fp_end
Definition: types.hpp:4178
std::string name
Definition: types.hpp:4175
std::optional< SnapshotReportedMetric > fr_invest_cash
Definition: types.hpp:4187
std::string currency
Definition: types.hpp:4179
std::string fp_start
Definition: types.hpp:4177
std::string fr_leverage_ttm
Definition: types.hpp:4195
std::string report_desc
Definition: types.hpp:4180
std::optional< SnapshotReportedMetric > fr_profit
Definition: types.hpp:4185
std::optional< SnapshotReportedMetric > fr_operate_cash
Definition: types.hpp:4186
std::optional< SnapshotReportedMetric > fr_total_assets
Definition: types.hpp:4189
std::optional< SnapshotReportedMetric > fr_revenue
Definition: types.hpp:4184
std::string fr_roe_ttm
Definition: types.hpp:4191
std::optional< SnapshotForecastMetric > fo_eps
Definition: types.hpp:4183
std::string fr_profit_margin_ttm
Definition: types.hpp:4193
std::string fr_profit_margin
Definition: types.hpp:4192
std::optional< SnapshotForecastMetric > fo_revenue
Definition: types.hpp:4181
std::optional< SnapshotReportedMetric > fr_finance_cash
Definition: types.hpp:4188
std::optional< SnapshotReportedMetric > fr_total_liability
Definition: types.hpp:4190
std::string fr_debt_assets_ratio
Definition: types.hpp:4196
std::string ticker
Definition: types.hpp:4176
Financial reports — list_json contains serialized JSON.
Definition: types.hpp:3846
std::string list_json
Definition: types.hpp:3847
Collection of forecast EPS items.
Definition: types.hpp:3650
std::vector< ForecastEpsItem > items
Definition: types.hpp:3651
Forecast EPS data point from institutional analysts.
Definition: types.hpp:3636
std::string forecast_eps_highest
Definition: types.hpp:3640
std::string forecast_eps_median
Definition: types.hpp:3637
int64_t forecast_start_date
Definition: types.hpp:3644
int32_t institution_total
Definition: types.hpp:3641
std::string forecast_eps_mean
Definition: types.hpp:3638
int32_t institution_up
Definition: types.hpp:3642
int64_t forecast_end_date
Definition: types.hpp:3645
std::string forecast_eps_lowest
Definition: types.hpp:3639
int32_t institution_down
Definition: types.hpp:3643
One fund's holding record for a security.
Definition: types.hpp:3755
std::string code
Definition: types.hpp:3756
std::string name
Definition: types.hpp:3759
std::string currency
Definition: types.hpp:3758
std::string report_date
Definition: types.hpp:3761
std::string position_ratio
Definition: types.hpp:3760
std::string symbol
Definition: types.hpp:3757
Collection of fund holders for a security.
Definition: types.hpp:3766
std::vector< FundHolder > lists
Definition: types.hpp:3767
Holding detail of an ETF asset allocation element (holdings only)
Definition: types.hpp:4251
std::string industry_id
Industry ID.
Definition: types.hpp:4253
std::string index_name
Index name.
Definition: types.hpp:4259
std::string industry_name
Industry name.
Definition: types.hpp:4255
std::string holding_type_name
Holding type name.
Definition: types.hpp:4263
std::string holding_type
Holding type (e.g. E for stock)
Definition: types.hpp:4261
std::string index
Index counter ID (e.g. BK/US/CP99000)
Definition: types.hpp:4257
Definition: types.hpp:4140
std::string ytd_chg
Definition: types.hpp:4145
std::string chg
Definition: types.hpp:4144
std::string symbol
Definition: types.hpp:4142
std::string next_json
Definition: types.hpp:4146
std::string name
Definition: types.hpp:4141
int32_t stock_num
Definition: types.hpp:4143
Industry peers response.
Definition: types.hpp:4151
std::optional< IndustryPeersTop > top
Definition: types.hpp:4152
std::optional< IndustryPeerNode > chain
Definition: types.hpp:4153
Top-level industry info in the peers response.
Definition: types.hpp:4131
std::string name
Definition: types.hpp:4132
std::string market
Definition: types.hpp:4133
A group of ranked industry items.
Definition: types.hpp:4119
std::vector< IndustryRankItem > lists
Definition: types.hpp:4120
One ranked industry item.
Definition: types.hpp:4106
std::string leading_ticker
Definition: types.hpp:4111
std::string leading_name
Definition: types.hpp:4110
std::string symbol
Definition: types.hpp:4108
std::string value_name
Definition: types.hpp:4113
std::string value_data
Definition: types.hpp:4114
std::string leading_chg
Definition: types.hpp:4112
std::string chg
Definition: types.hpp:4109
std::string name
Definition: types.hpp:4107
Industry rank response.
Definition: types.hpp:4125
std::vector< IndustryRankGroup > items
Definition: types.hpp:4126
Industry valuation distribution for PE, PB, PS ratios.
Definition: types.hpp:3929
std::optional< ValuationDist > pb
Definition: types.hpp:3931
std::optional< ValuationDist > pe
Definition: types.hpp:3930
std::optional< ValuationDist > ps
Definition: types.hpp:3932
Historical valuation snapshot for an industry peer.
Definition: types.hpp:3885
std::string ps
Definition: types.hpp:3889
std::string date
Definition: types.hpp:3886
std::string pe
Definition: types.hpp:3887
std::string pb
Definition: types.hpp:3888
Valuation data for one industry peer security.
Definition: types.hpp:3894
std::string currency
Definition: types.hpp:3897
std::string five_y_avg_dps
Definition: types.hpp:3904
std::string dps
Definition: types.hpp:3901
std::string div_yld
Definition: types.hpp:3902
std::string pe
Definition: types.hpp:3905
std::string assets
Definition: types.hpp:3898
std::vector< IndustryValuationHistory > history
Definition: types.hpp:3906
std::string bps
Definition: types.hpp:3899
std::string div_payout_ratio
Definition: types.hpp:3903
std::string name
Definition: types.hpp:3896
std::string eps
Definition: types.hpp:3900
std::string symbol
Definition: types.hpp:3895
List of industry valuation items.
Definition: types.hpp:3911
std::vector< IndustryValuationItem > list
Definition: types.hpp:3912
One evaluation data point in an institutional rating detail series.
Definition: types.hpp:3602
int32_t strong_buy
Definition: types.hpp:3607
std::string date
Definition: types.hpp:3604
int32_t buy
Definition: types.hpp:3603
int32_t sell
Definition: types.hpp:3606
int32_t hold
Definition: types.hpp:3605
int32_t under
Definition: types.hpp:3608
Detailed institutional rating including historical evaluate and target series.
Definition: types.hpp:3625
std::string prediction_accuracy
Definition: types.hpp:3629
std::string updated_at
Definition: types.hpp:3630
std::vector< InstitutionRatingDetailTargetItem > target_list
Definition: types.hpp:3631
std::string ccy_symbol
Definition: types.hpp:3626
std::string data_percent
Definition: types.hpp:3628
std::vector< InstitutionRatingDetailEvaluateItem > evaluate_list
Definition: types.hpp:3627
One target price data point in an institutional rating detail series.
Definition: types.hpp:3613
bool meet
Definition: types.hpp:3618
std::string min_target
Definition: types.hpp:3617
std::string avg_target
Definition: types.hpp:3614
std::string price
Definition: types.hpp:3619
std::string date
Definition: types.hpp:3615
std::string max_target
Definition: types.hpp:3616
std::string timestamp
Definition: types.hpp:3620
Combined latest and summary institutional rating data.
Definition: types.hpp:3595
InstitutionRatingLatest latest
Definition: types.hpp:3596
InstitutionRatingSummary summary
Definition: types.hpp:3597
Latest institutional rating data including industry comparison.
Definition: types.hpp:3571
RatingEvaluate evaluate
Definition: types.hpp:3572
int32_t industry_median
Definition: types.hpp:3579
RatingTarget target
Definition: types.hpp:3573
int32_t industry_rank
Definition: types.hpp:3576
std::string industry_name
Definition: types.hpp:3575
int32_t industry_mean
Definition: types.hpp:3578
int32_t industry_total
Definition: types.hpp:3577
int64_t industry_id
Definition: types.hpp:3574
Institutional rating summary with current recommendation and target price.
Definition: types.hpp:3584
std::string updated_at
Definition: types.hpp:3590
std::string target
Definition: types.hpp:3589
std::string change
Definition: types.hpp:3586
std::string ccy_symbol
Definition: types.hpp:3585
RatingSummaryEvaluate evaluate
Definition: types.hpp:3587
InstitutionRecommend recommend
Definition: types.hpp:3588
One historical rating distribution snapshot.
Definition: types.hpp:4088
std::string sell
Definition: types.hpp:4094
std::string over
Definition: types.hpp:4091
std::string under
Definition: types.hpp:4093
std::string hold
Definition: types.hpp:4092
std::string total
Definition: types.hpp:4095
std::string buy
Definition: types.hpp:4090
std::string date
Definition: types.hpp:4089
Institution rating views response.
Definition: types.hpp:4100
std::vector< InstitutionRatingViewItem > elist
Definition: types.hpp:4101
Investment relationship data including parent/subsidiary securities.
Definition: types.hpp:3808
std::string forward_url
Definition: types.hpp:3809
std::vector< InvestSecurity > invest_securities
Definition: types.hpp:3810
One security in an investment relationship (parent/subsidiary holding).
Definition: types.hpp:3794
std::string company_name_en
Definition: types.hpp:3797
std::string company_id
Definition: types.hpp:3795
std::string symbol
Definition: types.hpp:3799
std::string shares_value
Definition: types.hpp:3803
std::string percent_of_shares
Definition: types.hpp:3801
std::string company_name
Definition: types.hpp:3796
std::string currency
Definition: types.hpp:3800
std::string company_name_zhcn
Definition: types.hpp:3798
std::string shares_rank
Definition: types.hpp:3802
One operating indicator from a financial report.
Definition: types.hpp:3815
std::string indicator_value
Definition: types.hpp:3818
std::string indicator_name
Definition: types.hpp:3817
std::string field_name
Definition: types.hpp:3816
std::string yoy
Definition: types.hpp:3819
One operating report item with associated indicators.
Definition: types.hpp:3824
std::vector< OperatingIndicator > indicators
Definition: types.hpp:3835
std::string txt
Definition: types.hpp:3828
std::string financial_currency
Definition: types.hpp:3831
std::string title
Definition: types.hpp:3827
bool latest
Definition: types.hpp:3829
std::string financial_region
Definition: types.hpp:3833
std::string web_url
Definition: types.hpp:3830
std::string financial_name
Definition: types.hpp:3832
std::string financial_report
Definition: types.hpp:3834
std::string id
Definition: types.hpp:3825
std::string report
Definition: types.hpp:3826
List of operating report items.
Definition: types.hpp:3840
std::vector< OperatingItem > list
Definition: types.hpp:3841
One executive or board member.
Definition: types.hpp:3937
std::string title
Definition: types.hpp:3942
std::string id
Definition: types.hpp:3938
std::string name_en
Definition: types.hpp:3941
std::string photo
Definition: types.hpp:3944
std::string name
Definition: types.hpp:3939
std::string name_zhcn
Definition: types.hpp:3940
std::string biography
Definition: types.hpp:3943
std::string wiki_url
Definition: types.hpp:3945
One rating category (e.g. growth, profitability).
Definition: types.hpp:4024
int32_t kind
Definition: types.hpp:4025
std::vector< RatingSubIndicatorGroup > sub_indicators
Definition: types.hpp:4026
Buy/sell/hold evaluation counts from institutional analysts.
Definition: types.hpp:3536
std::string end_date
Definition: types.hpp:3545
int32_t total
Definition: types.hpp:3543
int32_t under
Definition: types.hpp:3540
int32_t buy
Definition: types.hpp:3537
int32_t over
Definition: types.hpp:3538
int32_t hold
Definition: types.hpp:3539
int32_t sell
Definition: types.hpp:3541
std::string start_date
Definition: types.hpp:3544
int32_t no_opinion
Definition: types.hpp:3542
A rating indicator node (parent or leaf).
Definition: types.hpp:4009
std::string letter
Definition: types.hpp:4012
std::string name
Definition: types.hpp:4010
std::string score
Definition: types.hpp:4011
A leaf rating indicator with a raw value.
Definition: types.hpp:3999
std::string value_type
Definition: types.hpp:4002
std::string score
Definition: types.hpp:4003
std::string name
Definition: types.hpp:4000
std::string letter
Definition: types.hpp:4004
std::string value
Definition: types.hpp:4001
A group of sub-indicators under one category indicator.
Definition: types.hpp:4017
RatingIndicator indicator
Definition: types.hpp:4018
std::vector< RatingLeafIndicator > sub_indicators
Definition: types.hpp:4019
Summary evaluation counts for one rating period.
Definition: types.hpp:3560
int32_t under
Definition: types.hpp:3566
int32_t sell
Definition: types.hpp:3564
int32_t strong_buy
Definition: types.hpp:3565
std::string date
Definition: types.hpp:3562
int32_t buy
Definition: types.hpp:3561
int32_t hold
Definition: types.hpp:3563
Analyst price target range.
Definition: types.hpp:3550
std::string prev_close
Definition: types.hpp:3553
std::string start_date
Definition: types.hpp:3554
std::string end_date
Definition: types.hpp:3555
std::string lowest_price
Definition: types.hpp:3552
std::string highest_price
Definition: types.hpp:3551
TTM (trailing twelve months) buyback summary.
Definition: types.hpp:3965
std::string net_buyback_yield_ttm
Definition: types.hpp:3968
std::string currency
Definition: types.hpp:3966
std::string net_buyback_ttm
Definition: types.hpp:3967
One institutional or major shareholder record.
Definition: types.hpp:3735
std::string percent_of_shares
Definition: types.hpp:3739
std::vector< ShareholderStock > stocks
Definition: types.hpp:3742
std::string shares_changed
Definition: types.hpp:3740
std::string shareholder_name
Definition: types.hpp:3737
std::string institution_type
Definition: types.hpp:3738
std::string report_date
Definition: types.hpp:3741
std::string shareholder_id
Definition: types.hpp:3736
Paginated list of shareholders.
Definition: types.hpp:3747
std::string forward_url
Definition: types.hpp:3749
int32_t total
Definition: types.hpp:3750
std::vector< Shareholder > shareholder_list
Definition: types.hpp:3748
A security held by a shareholder.
Definition: types.hpp:3726
std::string market
Definition: types.hpp:3729
std::string chg
Definition: types.hpp:3730
std::string symbol
Definition: types.hpp:3727
std::string code
Definition: types.hpp:3728
A forecast metric in the financial report snapshot.
Definition: types.hpp:4158
std::string est_value
Definition: types.hpp:4162
std::string cmp_desc
Definition: types.hpp:4161
std::string yoy
Definition: types.hpp:4160
std::string value
Definition: types.hpp:4159
A reported metric in the financial report snapshot.
Definition: types.hpp:4167
std::string yoy
Definition: types.hpp:4169
std::string value
Definition: types.hpp:4168
Stock ratings response.
Definition: types.hpp:4031
int32_t multi_score_change
Definition: types.hpp:4037
std::string multi_score
Definition: types.hpp:4035
std::string industry_rank
Definition: types.hpp:4039
std::string multi_letter
Definition: types.hpp:4036
std::string style_txt_name
Definition: types.hpp:4032
std::string industry_median_score
Definition: types.hpp:4042
std::string industry_total
Definition: types.hpp:4040
std::vector< RatingCategory > ratings
Definition: types.hpp:4043
std::string scale_txt_name
Definition: types.hpp:4033
std::string report_period_txt
Definition: types.hpp:4034
std::string industry_name
Definition: types.hpp:4038
std::string industry_mean_score
Definition: types.hpp:4041
One security's valuation comparison item.
Definition: types.hpp:4210
std::string currency
Definition: types.hpp:4213
std::string pb
Definition: types.hpp:4217
std::string market_value
Definition: types.hpp:4214
std::string assets
Definition: types.hpp:4224
std::string eps
Definition: types.hpp:4220
std::string pe
Definition: types.hpp:4216
std::string symbol
Definition: types.hpp:4211
std::string name
Definition: types.hpp:4212
std::vector< ValuationHistoryPoint > history
Definition: types.hpp:4225
std::string ps
Definition: types.hpp:4218
std::string price_close
Definition: types.hpp:4215
std::string dps
Definition: types.hpp:4222
std::string roe
Definition: types.hpp:4219
std::string div_yld
Definition: types.hpp:4223
std::string bps
Definition: types.hpp:4221
Valuation comparison response.
Definition: types.hpp:4230
std::vector< ValuationComparisonItem > list
Definition: types.hpp:4231
Valuation data container.
Definition: types.hpp:3682
ValuationMetricsData metrics
Definition: types.hpp:3683
Distribution statistics for one valuation metric within an industry.
Definition: types.hpp:3917
std::string ranking
Definition: types.hpp:3922
std::string rank_total
Definition: types.hpp:3924
std::string high
Definition: types.hpp:3919
std::string low
Definition: types.hpp:3918
std::string value
Definition: types.hpp:3921
std::string rank_index
Definition: types.hpp:3923
std::string median
Definition: types.hpp:3920
One historical valuation data point.
Definition: types.hpp:4201
std::string ps
Definition: types.hpp:4205
std::string pe
Definition: types.hpp:4203
std::string date
Definition: types.hpp:4202
std::string pb
Definition: types.hpp:4204
Historical valuation response (PE, PB, PS without dividend yield).
Definition: types.hpp:3688
std::optional< ValuationMetricData > pe
Definition: types.hpp:3689
std::optional< ValuationMetricData > ps
Definition: types.hpp:3691
std::optional< ValuationMetricData > pb
Definition: types.hpp:3690
Historical data for one valuation metric (PE, PB, PS, or dividend yield).
Definition: types.hpp:3663
std::vector< ValuationPoint > list
Definition: types.hpp:3668
std::string high
Definition: types.hpp:3665
std::string low
Definition: types.hpp:3666
std::string desc
Definition: types.hpp:3664
std::string median
Definition: types.hpp:3667
All valuation metrics for a security.
Definition: types.hpp:3673
std::optional< ValuationMetricData > dvd_yld
Definition: types.hpp:3677
std::optional< ValuationMetricData > ps
Definition: types.hpp:3676
std::optional< ValuationMetricData > pb
Definition: types.hpp:3675
std::optional< ValuationMetricData > pe
Definition: types.hpp:3674
One data point in a valuation time series.
Definition: types.hpp:3656
int64_t timestamp
Definition: types.hpp:3657
std::string value
Definition: types.hpp:3658
Options for get grid trading order detail request.
Definition: types.hpp:2740
std::optional< int32_t > limit
Page size.
Definition: types.hpp:2746
std::string order_id
Grid master order ID.
Definition: types.hpp:2742
std::optional< std::string > history_id
History cursor for paging through the trigger history.
Definition: types.hpp:2744
Options for query grid trading orders by IDs request.
Definition: types.hpp:2733
std::vector< std::string > order_ids
Grid master order IDs.
Definition: types.hpp:2735
Options for get grid trading orders (list) request.
Definition: types.hpp:2714
std::optional< int32_t > limit
Page size.
Definition: types.hpp:2718
std::optional< std::string > sort_order
Sort order.
Definition: types.hpp:2728
std::optional< std::string > status
Comma-joined status filter (e.g. Performing,Suspended)
Definition: types.hpp:2722
std::optional< int32_t > page
Page number.
Definition: types.hpp:2716
std::optional< Market > market
Market.
Definition: types.hpp:2720
std::optional< std::string > sort_by
Sort field.
Definition: types.hpp:2726
std::optional< std::string > symbol
Security symbol filter (e.g. 700.HK)
Definition: types.hpp:2724
Options for get grid trading trigger history request.
Definition: types.hpp:2751
std::optional< int32_t > page
Page number.
Definition: types.hpp:2755
std::string grid_order_id
Grid master order ID.
Definition: types.hpp:2753
std::optional< int32_t > limit
Page size.
Definition: types.hpp:2757
A price-step (bid-size) rule entry from the symbol-info response.
Definition: types.hpp:3040
std::optional< Decimal > end_proceed
Range end price.
Definition: types.hpp:3044
std::optional< Decimal > str_proceed
Range start price (inclusive)
Definition: types.hpp:3042
std::optional< Decimal > bid_size
Price step within the range.
Definition: types.hpp:3046
Channel / authorization info nested in the symbol-info response.
Definition: types.hpp:3051
bool strategy_granted
Whether the strategy compliance authorization has been granted.
Definition: types.hpp:3053
std::string currency
Trading currency.
Definition: types.hpp:3057
std::vector< std::string > settlement_currency
Supported settlement currencies.
Definition: types.hpp:3059
bool support_rth
Whether the RTH toggle is supported.
Definition: types.hpp:3055
Detail of a grid trading order.
Definition: types.hpp:2902
GridLimitEvent upper_limit_event
Action at the upper bound.
Definition: types.hpp:2958
bool sub_has_more
Whether there are more sub-orders to page.
Definition: types.hpp:2978
std::string grid_status
Grid running status.
Definition: types.hpp:2912
std::optional< Decimal > pullback_spread
Pullback spread.
Definition: types.hpp:2938
std::vector< GridOrderHistory > grid_order_history
Lifecycle history entries.
Definition: types.hpp:2980
std::optional< Decimal > trigger_percent_up
Upward trigger percent.
Definition: types.hpp:2932
std::optional< int64_t > created_at
Created time (unix timestamp)
Definition: types.hpp:2966
std::vector< GridOrderSubOrder > grid_sub_orders
Triggered sub-orders.
Definition: types.hpp:2976
std::string stock_name
Stock name.
Definition: types.hpp:2908
GridLimitEvent lower_limit_event
Action at the lower bound.
Definition: types.hpp:2960
std::string status
Order status.
Definition: types.hpp:2910
std::string sleeping_reason
Sleeping reason, if any.
Definition: types.hpp:2916
std::string order_id
Grid master order ID.
Definition: types.hpp:2904
std::optional< int64_t > expire_time
Expiry time (unix timestamp)
Definition: types.hpp:2972
std::optional< Decimal > current_base_price
Current base price.
Definition: types.hpp:2920
std::optional< Decimal > lower_limit_price
Lower price bound.
Definition: types.hpp:2924
std::optional< Decimal > rebound_spread
Rebound spread.
Definition: types.hpp:2942
std::string grid_order_type_up
Sell-side grid order type (GMO / GLO / GTG)
Definition: types.hpp:2988
std::optional< int64_t > updated_at
Last updated time (unix timestamp)
Definition: types.hpp:2968
std::optional< Decimal > trigger_spread_down
Downward trigger spread.
Definition: types.hpp:2930
std::string gtd
Expiry date (YYYY-MM-DD, GTD)
Definition: types.hpp:2974
std::string settlement_currency
Settlement currency.
Definition: types.hpp:2970
std::optional< Decimal > upper_limit_price
Upper price bound.
Definition: types.hpp:2922
GridTimeInForce time_in_force
Time in force.
Definition: types.hpp:2946
int32_t trigger_buy_depth
Buy-side order-book depth.
Definition: types.hpp:2964
std::optional< Decimal > trigger_sell_quantity
Quantity per sell trigger.
Definition: types.hpp:2950
bool history_has_more
Whether there are more history entries to page.
Definition: types.hpp:2982
std::string suspend_reason
Suspend reason, if any.
Definition: types.hpp:2914
std::optional< Decimal > upper_limit_quantity
Quantity handled at the upper bound.
Definition: types.hpp:2954
int32_t trigger_sell_depth
Sell-side order-book depth.
Definition: types.hpp:2962
std::string symbol
Security symbol (e.g. 700.HK)
Definition: types.hpp:2906
std::optional< Decimal > trigger_spread_up
Upward trigger spread.
Definition: types.hpp:2928
std::optional< Decimal > trigger_percent_down
Downward trigger percent.
Definition: types.hpp:2934
TriggerPriceType trigger_price_type
Trigger price type.
Definition: types.hpp:2926
int32_t rth
Regular trading hours flag.
Definition: types.hpp:2986
bool multiple_trigger
Whether a single grid level may trigger multiple times.
Definition: types.hpp:2944
std::optional< Decimal > rebound_percent
Rebound percent.
Definition: types.hpp:2940
std::optional< Decimal > trigger_quantity
Quantity per trigger.
Definition: types.hpp:2948
std::optional< Decimal > pullback_percent
Pullback percent.
Definition: types.hpp:2936
std::optional< Decimal > lower_limit_quantity
Quantity handled at the lower bound.
Definition: types.hpp:2956
std::optional< Decimal > submitted_base_price
Submitted base price.
Definition: types.hpp:2918
std::string grid_order_type_down
Buy-side grid order type (GMO / GLO / GTG)
Definition: types.hpp:2990
std::optional< Decimal > trigger_buy_quantity
Quantity per buy trigger.
Definition: types.hpp:2952
bool support_shortsell
Whether short selling is allowed.
Definition: types.hpp:2984
A grid order lifecycle-history entry carried in the grid order detail.
Definition: types.hpp:2887
std::optional< int64_t > created_at
Created time (unix timestamp)
Definition: types.hpp:2891
std::string reason
Additional reason detail, if any.
Definition: types.hpp:2897
std::string history_id
History entry ID (paging cursor)
Definition: types.hpp:2889
std::string status
Status at this point.
Definition: types.hpp:2893
std::string suspend_reason
Suspend reason, if any.
Definition: types.hpp:2895
A grid trading order (element of the list / by-ids responses).
Definition: types.hpp:2769
std::optional< Decimal > current_base_price
Current base price.
Definition: types.hpp:2785
int32_t trigger_times
Number of times the grid has triggered.
Definition: types.hpp:2837
std::string symbol
Security symbol (e.g. 700.HK)
Definition: types.hpp:2773
std::string status
Order status.
Definition: types.hpp:2779
std::optional< Decimal > total_sell_quantity
Accumulated sold quantity.
Definition: types.hpp:2841
std::string settlement_currency
Settlement currency.
Definition: types.hpp:2845
std::optional< Decimal > submitted_base_price
Submitted base price.
Definition: types.hpp:2783
std::string order_id
Grid master order ID.
Definition: types.hpp:2771
GridLimitEvent upper_limit_event
Action at the upper bound.
Definition: types.hpp:2831
std::optional< Decimal > lower_limit_quantity
Quantity handled at the lower bound.
Definition: types.hpp:2829
std::optional< Decimal > rebound_percent
Rebound percent.
Definition: types.hpp:2809
bool support_shortsell
Whether short selling is allowed.
Definition: types.hpp:2855
std::optional< Decimal > lower_limit_price
Lower price bound.
Definition: types.hpp:2793
GridLimitEvent lower_limit_event
Action at the lower bound.
Definition: types.hpp:2833
std::optional< Decimal > post_trigger_base_price
Base price after the last trigger.
Definition: types.hpp:2789
std::optional< Decimal > pullback_percent
Pullback percent.
Definition: types.hpp:2805
int32_t rth
Regular trading hours flag.
Definition: types.hpp:2853
std::optional< Decimal > trigger_percent_down
Downward trigger percent.
Definition: types.hpp:2803
std::string grid_order_type_up
Sell-side grid order type (GMO / GLO / GTG)
Definition: types.hpp:2857
std::optional< Decimal > rebound_spread
Rebound spread.
Definition: types.hpp:2811
std::string trigger_buy_order_type
Buy-side execution order type (e.g. MO)
Definition: types.hpp:2815
std::optional< Decimal > trigger_quantity
Quantity per trigger.
Definition: types.hpp:2821
std::optional< Decimal > upper_limit_quantity
Quantity handled at the upper bound.
Definition: types.hpp:2827
std::string grid_order_type_down
Buy-side grid order type (GMO / GLO / GTG)
Definition: types.hpp:2859
std::optional< Decimal > pre_trigger_base_price
Base price before the last trigger.
Definition: types.hpp:2787
std::optional< Decimal > trigger_buy_quantity
Quantity per buy trigger.
Definition: types.hpp:2825
std::optional< Decimal > trigger_spread_up
Upward trigger spread.
Definition: types.hpp:2797
std::optional< Decimal > trigger_spread_down
Downward trigger spread.
Definition: types.hpp:2799
std::optional< Decimal > total_profit_balance
Accumulated profit balance.
Definition: types.hpp:2843
std::string stock_name
Stock name.
Definition: types.hpp:2775
bool multiple_trigger
Whether a single grid level may trigger multiple times.
Definition: types.hpp:2835
int32_t trigger_buy_depth
Buy-side order-book depth.
Definition: types.hpp:2819
std::string market
Market.
Definition: types.hpp:2777
std::string gtd
Expiry date (YYYY-MM-DD, GTD)
Definition: types.hpp:2849
std::optional< Decimal > trigger_percent_up
Upward trigger percent.
Definition: types.hpp:2801
GridTimeInForce time_in_force
Time in force.
Definition: types.hpp:2847
std::optional< Decimal > total_buy_quantity
Accumulated bought quantity.
Definition: types.hpp:2839
std::optional< Decimal > pullback_spread
Pullback spread.
Definition: types.hpp:2807
std::string grid_status
Grid running status.
Definition: types.hpp:2781
std::string trigger_sell_order_type
Sell-side execution order type (e.g. MO)
Definition: types.hpp:2813
std::optional< int64_t > created_at
Created time (unix timestamp)
Definition: types.hpp:2851
TriggerPriceType trigger_price_type
Trigger price type.
Definition: types.hpp:2795
std::optional< Decimal > trigger_sell_quantity
Quantity per sell trigger.
Definition: types.hpp:2823
std::optional< Decimal > upper_limit_price
Upper price bound.
Definition: types.hpp:2791
int32_t trigger_sell_depth
Sell-side order-book depth.
Definition: types.hpp:2817
A triggered sub-order carried in the grid order detail.
Definition: types.hpp:2864
std::string id
Sub-order ID.
Definition: types.hpp:2866
std::optional< Decimal > executed_qty
Executed quantity.
Definition: types.hpp:2874
std::optional< Decimal > price
Order price.
Definition: types.hpp:2868
std::optional< int64_t > submitted_at
Submitted time (unix timestamp)
Definition: types.hpp:2880
std::optional< Decimal > quantity
Order quantity.
Definition: types.hpp:2872
std::string order_type
Order type.
Definition: types.hpp:2870
std::string status
Order status.
Definition: types.hpp:2878
int32_t rth
Regular trading hours flag.
Definition: types.hpp:2882
int32_t action
Buy / sell direction.
Definition: types.hpp:2876
Response for get grid trading orders (list) request.
Definition: types.hpp:3083
std::vector< GridOrder > grid_order
Grid orders.
Definition: types.hpp:3085
bool has_more
Whether there are more pages.
Definition: types.hpp:3087
Security (symbol) info used to build a grid order.
Definition: types.hpp:3064
std::vector< GridBidSize > bid_sizes
Price-step (bid-size) rule table.
Definition: types.hpp:3076
std::optional< Decimal > lot_size
Board lot size.
Definition: types.hpp:3070
std::optional< Decimal > sell_lot_size
Sell-side board lot size.
Definition: types.hpp:3074
GridChannelInfo channel_info
Channel / authorization info (strategy grant, RTH, currencies)
Definition: types.hpp:3078
std::optional< Decimal > last_done
Latest quote price.
Definition: types.hpp:3068
std::string name
Security name.
Definition: types.hpp:3066
std::optional< Decimal > buy_lot_size
Buy-side board lot size.
Definition: types.hpp:3072
Definition: types.hpp:2559
std::optional< GridLimitEvent > lower_limit_event
Definition: types.hpp:2591
std::optional< bool > support_shortsell
Whether short selling is allowed.
Definition: types.hpp:2599
GridTradeRule & with_depths(int32_t sell, int32_t buy)
Set the sell / buy order-book depths (0 = use the order type).
Definition: types.hpp:2648
GridTradeRule & with_expire_time(int64_t unix_seconds)
Set the expiry time (unix seconds), used with a GTD time-in-force.
Definition: types.hpp:2685
std::optional< Decimal > submitted_base_price
Base price the grid is anchored to.
Definition: types.hpp:2561
std::optional< std::string > grid_order_type_down
Buy-side order type when depth is 0 (GMO / GLO / GTG)
Definition: types.hpp:2605
std::optional< int32_t > trigger_sell_depth
Sell-side order-book depth (-5..5, 0 = use grid_order_type_up)
Definition: types.hpp:2593
GridTradeRule & with_order_types(std::string up, std::string down)
Set the sell / buy order types (GMO / GLO / GTG).
Definition: types.hpp:2656
std::optional< Decimal > upper_limit_price
Upper price bound.
Definition: types.hpp:2563
std::optional< Decimal > trigger_spread_down
Downward trigger spread (absolute)
Definition: types.hpp:2571
std::optional< GridTimeInForce > time_in_force
Time in force (Day / GoodTilCanceled / GoodTilDate)
Definition: types.hpp:2579
std::optional< bool > multiple_trigger
Whether a single grid level may trigger multiple times.
Definition: types.hpp:2577
std::optional< Decimal > lower_limit_price
Lower price bound.
Definition: types.hpp:2565
std::optional< int32_t > trigger_buy_depth
Buy-side order-book depth (-5..5, 0 = use grid_order_type_down)
Definition: types.hpp:2595
std::optional< GridLimitEvent > upper_limit_event
Definition: types.hpp:2588
std::optional< int64_t > expire_time
Expiry time (unix seconds), used with GTD.
Definition: types.hpp:2585
static GridTradeRule create(Decimal base_price, Decimal upper_price, Decimal lower_price, GridTrigger trigger, Decimal quantity, Decimal upper_quantity, Decimal lower_quantity, GridTimeInForce time_in_force)
Definition: types.hpp:2610
std::optional< std::string > grid_order_type_up
Sell-side order type when depth is 0 (GMO / GLO / GTG)
Definition: types.hpp:2603
GridTradeRule & with_multiple_trigger(bool value)
Allow a single grid level to trigger multiple times.
Definition: types.hpp:2664
std::optional< TriggerPriceType > trigger_price_type
Trigger price type (only Spread / Percent allowed)
Definition: types.hpp:2567
std::optional< Decimal > lower_limit_quantity
Quantity handled when the lower bound is reached.
Definition: types.hpp:2583
GridTradeRule & with_support_shortsell(bool value)
Allow short selling.
Definition: types.hpp:2671
std::optional< Decimal > trigger_quantity
Quantity per trigger.
Definition: types.hpp:2597
std::optional< Decimal > upper_limit_quantity
Quantity handled when the upper bound is reached.
Definition: types.hpp:2581
GridTradeRule & with_limit_events(GridLimitEvent upper, GridLimitEvent lower)
Set the actions taken at the upper / lower bounds.
Definition: types.hpp:2640
std::optional< Decimal > trigger_spread_up
Upward trigger spread (absolute)
Definition: types.hpp:2569
GridTradeRule & with_rth(int32_t value)
Set the regular-trading-hours flag (0 / 1 / 2).
Definition: types.hpp:2678
std::optional< Decimal > trigger_percent_down
Downward trigger percent.
Definition: types.hpp:2575
std::optional< Decimal > trigger_percent_up
Upward trigger percent.
Definition: types.hpp:2573
std::optional< int32_t > rth
Regular trading hours flag (0 / 1 / 2)
Definition: types.hpp:2601
Response for get grid trading trigger history request.
Definition: types.hpp:3092
std::vector< TriggerOrder > trigger_orders
Trigger history entries.
Definition: types.hpp:3094
bool has_more
Whether there are more pages.
Definition: types.hpp:3096
Definition: types.hpp:2525
Decimal up
Upward trigger threshold.
Definition: types.hpp:2537
Kind
Threshold interpretation kind.
Definition: types.hpp:2528
@ Spread
Trigger by absolute price spread.
@ Percent
Trigger by percent.
Decimal down
Downward trigger threshold.
Definition: types.hpp:2539
static GridTrigger spread(Decimal up, Decimal down)
Trigger by absolute price spread (up, down).
Definition: types.hpp:2547
Kind kind
Which interpretation the up / down values use.
Definition: types.hpp:2535
static GridTrigger percent(Decimal up, Decimal down)
Trigger by percent (up, down).
Definition: types.hpp:2542
Options for replace grid trading order request.
Definition: types.hpp:2705
GridTradeRule grid_trading_rule
Grid trading rule.
Definition: types.hpp:2709
std::string order_id
Grid master order ID.
Definition: types.hpp:2707
Options for submit grid trading order request.
Definition: types.hpp:2694
GridTradeRule grid_trading_rule
Grid trading rule.
Definition: types.hpp:2700
std::string symbol
Security symbol (e.g. 700.HK)
Definition: types.hpp:2696
std::string settlement_currency
Settlement currency.
Definition: types.hpp:2698
Response for submit grid trading order request.
Definition: types.hpp:2762
std::string order_id
Grid master order id.
Definition: types.hpp:2764
A grid trigger-history entry (one triggered order).
Definition: types.hpp:2995
GridTimeInForce time_in_force
Time in force.
Definition: types.hpp:3029
std::string status
Order status.
Definition: types.hpp:2999
std::string msg
Rejection reason, if any.
Definition: types.hpp:3021
std::optional< Decimal > executed_qty
Executed total quantity.
Definition: types.hpp:3011
std::string currency
Settlement currency.
Definition: types.hpp:3023
int32_t trigger_status
Conditional trigger status.
Definition: types.hpp:3035
std::optional< Decimal > executed_price
Executed average price.
Definition: types.hpp:3009
std::optional< Decimal > quantity
Order quantity.
Definition: types.hpp:3007
std::optional< int64_t > trigger_at
Trigger time (unix timestamp)
Definition: types.hpp:3033
std::optional< int64_t > submitted_at
Submitted time (unix timestamp)
Definition: types.hpp:3013
int32_t action
Buy / sell direction.
Definition: types.hpp:3015
std::optional< Decimal > last_done
Latest quote price.
Definition: types.hpp:3025
std::string id
Triggered order ID.
Definition: types.hpp:2997
std::string name
Stock name.
Definition: types.hpp:3001
std::optional< int64_t > updated_at
Last updated time (unix timestamp)
Definition: types.hpp:3027
std::string order_type
Order type.
Definition: types.hpp:3017
std::optional< Decimal > price
Order price.
Definition: types.hpp:3005
std::string symbol
Security symbol (e.g. 700.HK)
Definition: types.hpp:3003
std::string gtd
Expiry date (YYYY-MM-DD, GTD)
Definition: types.hpp:3031
std::optional< Decimal > trigger_price
Trigger price.
Definition: types.hpp:3019
Intraday A/H premium kline series.
Definition: types.hpp:3332
std::vector< AhPremiumKline > klines
Definition: types.hpp:3333
A/H premium candlestick data point.
Definition: types.hpp:3313
std::string currency_rate
Definition: types.hpp:3318
std::string hprice
Definition: types.hpp:3316
std::string hpreclose
Definition: types.hpp:3317
int64_t timestamp
Definition: types.hpp:3321
std::string price_spread
Definition: types.hpp:3320
std::string ahpremium_rate
Definition: types.hpp:3319
std::string aprice
Definition: types.hpp:3314
std::string apreclose
Definition: types.hpp:3315
Historical A/H premium kline series.
Definition: types.hpp:3326
std::vector< AhPremiumKline > klines
Definition: types.hpp:3327
A single anomaly (unusual market movement) alert item.
Definition: types.hpp:3455
std::string alert_name
Definition: types.hpp:3458
int64_t alert_time
Definition: types.hpp:3459
std::string symbol
Definition: types.hpp:3456
std::string name
Definition: types.hpp:3457
int32_t emotion
Definition: types.hpp:3461
std::vector< std::string > change_values
Definition: types.hpp:3460
Response containing anomaly alert items.
Definition: types.hpp:3466
std::vector< AnomalyItem > changes
Definition: types.hpp:3468
bool all_off
Definition: types.hpp:3467
Holding change figures over multiple periods for a broker.
Definition: types.hpp:3271
std::string chg_5
Definition: types.hpp:3274
std::string chg_60
Definition: types.hpp:3276
std::string chg_1
Definition: types.hpp:3273
std::string chg_20
Definition: types.hpp:3275
std::string value
Definition: types.hpp:3272
Historical daily broker holding series.
Definition: types.hpp:3307
std::vector< BrokerHoldingDailyItem > list
Definition: types.hpp:3308
One day's broker holding snapshot.
Definition: types.hpp:3298
std::string chg
Definition: types.hpp:3302
std::string holding
Definition: types.hpp:3300
std::string ratio
Definition: types.hpp:3301
std::string date
Definition: types.hpp:3299
Full broker holding detail with historical change data.
Definition: types.hpp:3291
std::vector< BrokerHoldingDetailItem > list
Definition: types.hpp:3292
std::string updated_at
Definition: types.hpp:3293
Detailed holding entry for one broker including ratio and share changes.
Definition: types.hpp:3281
std::string name
Definition: types.hpp:3282
BrokerHoldingChanges ratio
Definition: types.hpp:3284
bool strong
Definition: types.hpp:3286
BrokerHoldingChanges shares
Definition: types.hpp:3285
std::string parti_number
Definition: types.hpp:3283
One broker's holding entry in a top-holders list.
Definition: types.hpp:3254
bool strong
Definition: types.hpp:3258
std::string name
Definition: types.hpp:3255
std::string parti_number
Definition: types.hpp:3256
std::string chg
Definition: types.hpp:3257
Top broker holders (buy and sell sides).
Definition: types.hpp:3263
std::vector< BrokerHoldingEntry > sell
Definition: types.hpp:3265
std::string updated_at
Definition: types.hpp:3266
std::vector< BrokerHoldingEntry > buy
Definition: types.hpp:3264
One constituent stock of an index.
Definition: types.hpp:3473
bool delay
Definition: types.hpp:3486
std::string last_done
Definition: types.hpp:3476
std::vector< std::string > tags
Definition: types.hpp:3482
std::string intro
Definition: types.hpp:3483
std::string prev_close
Definition: types.hpp:3477
std::string amount
Definition: types.hpp:3480
std::string circulating_shares
Definition: types.hpp:3485
int32_t trade_status
Definition: types.hpp:3488
std::string symbol
Definition: types.hpp:3474
std::string name
Definition: types.hpp:3475
std::string market
Definition: types.hpp:3484
std::string inflow
Definition: types.hpp:3478
std::string total_shares
Definition: types.hpp:3481
std::string balance
Definition: types.hpp:3479
std::string chg
Definition: types.hpp:3487
Index constituent stocks with rise/fall/flat counts.
Definition: types.hpp:3493
std::vector< ConstituentStock > stocks
Definition: types.hpp:3497
int32_t fall_num
Definition: types.hpp:3494
int32_t rise_num
Definition: types.hpp:3496
int32_t flat_num
Definition: types.hpp:3495
Response containing trading status for all markets.
Definition: types.hpp:3248
std::vector< MarketTimeItem > market_time
Definition: types.hpp:3249
Current trading status and timestamps for one market.
Definition: types.hpp:3236
int32_t delay_trade_status
Definition: types.hpp:3240
int32_t delay_sub_status
Definition: types.hpp:3243
longbridge::Market market
Definition: types.hpp:3237
int32_t sub_status
Definition: types.hpp:3242
std::string delay_timestamp
Definition: types.hpp:3241
int32_t trade_status
Definition: types.hpp:3238
std::string timestamp
Definition: types.hpp:3239
Response for rank_categories.
Definition: types.hpp:3449
std::vector< RankCategory > categories
Definition: types.hpp:3450
A top-level rank category grouping sub-categories.
Definition: types.hpp:3439
std::string name
Display name (e.g. "çƒåº¦æŽ’行")
Definition: types.hpp:3443
std::string key
Top-level key (e.g. "hot")
Definition: types.hpp:3441
std::vector< RankSubCategory > sub_categories
Definition: types.hpp:3444
One ranked security item.
Definition: types.hpp:3400
std::string volume_rate
Definition: types.hpp:3415
std::string change
Definition: types.hpp:3406
std::string pb_ttm
Definition: types.hpp:3416
std::string pre_post_chg
Definition: types.hpp:3411
std::string turnover_rate
Definition: types.hpp:3414
std::string code
Definition: types.hpp:3402
std::string last_done
Definition: types.hpp:3404
std::string pre_post_price
Definition: types.hpp:3410
std::string name
Definition: types.hpp:3403
std::string industry
Definition: types.hpp:3409
std::string chg
Definition: types.hpp:3405
std::string market_cap
Definition: types.hpp:3408
std::string amplitude
Definition: types.hpp:3412
std::string symbol
Definition: types.hpp:3401
std::string inflow
Definition: types.hpp:3407
std::string five_day_chg
Definition: types.hpp:3413
Response for rank_list.
Definition: types.hpp:3421
bool bmp
Definition: types.hpp:3422
std::vector< RankListItem > lists
Definition: types.hpp:3423
One leaf rank sub-category.
Definition: types.hpp:3428
std::string key
Sub-category key (e.g. "hot_all-us"). Pass to rank_list.
Definition: types.hpp:3430
std::string market
Market code (e.g. "US", "HK")
Definition: types.hpp:3434
std::string name
Display name.
Definition: types.hpp:3432
One top-movers event entry.
Definition: types.hpp:3382
std::string post
Definition: types.hpp:3387
TopMoversStock stock
Definition: types.hpp:3386
int64_t alert_type
Definition: types.hpp:3385
std::string alert_reason
Definition: types.hpp:3384
std::string timestamp
Definition: types.hpp:3383
Response for top_movers.
Definition: types.hpp:3392
std::string next_params
Pagination cursor (empty string means no more pages)
Definition: types.hpp:3395
std::vector< TopMoversEvent > events
Definition: types.hpp:3393
Stock information within a top-movers event.
Definition: types.hpp:3368
std::string symbol
Definition: types.hpp:3369
std::vector< std::string > labels
Definition: types.hpp:3377
std::string name
Definition: types.hpp:3371
std::string code
Definition: types.hpp:3370
std::string change
Definition: types.hpp:3373
std::string full_name
Definition: types.hpp:3372
std::string last_done
Definition: types.hpp:3374
std::string market
Definition: types.hpp:3375
std::string logo
Definition: types.hpp:3376
Trade volume and amount aggregated at one price level.
Definition: types.hpp:3338
std::string buy_amount
Definition: types.hpp:3339
std::string price
Definition: types.hpp:3341
std::string sell_amount
Definition: types.hpp:3342
std::string neutral_amount
Definition: types.hpp:3340
Aggregate buy/sell/neutral trade statistics for a security.
Definition: types.hpp:3347
std::string total_amount
Definition: types.hpp:3354
std::string timestamp
Definition: types.hpp:3353
std::string trades_count
Definition: types.hpp:3356
std::string preclose
Definition: types.hpp:3351
std::string neutral
Definition: types.hpp:3350
std::string buy
Definition: types.hpp:3349
std::string sell
Definition: types.hpp:3352
std::vector< std::string > trade_date
Definition: types.hpp:3355
std::string avgprice
Definition: types.hpp:3348
Response for trade statistics including per-price-level breakdown.
Definition: types.hpp:3361
std::vector< TradePriceLevel > trades
Definition: types.hpp:3363
TradeStatistics statistics
Definition: types.hpp:3362
Brokers.
Definition: types.hpp:250
std::vector< int32_t > broker_ids
Broker IDs.
Definition: types.hpp:254
int32_t position
Position.
Definition: types.hpp:252
Candlestick.
Definition: types.hpp:578
int64_t timestamp
Timestamp.
Definition: types.hpp:592
TradeSession trade_session
Trade session.
Definition: types.hpp:594
Decimal turnover
Turnover.
Definition: types.hpp:590
Decimal close
Close price.
Definition: types.hpp:580
Decimal high
High price.
Definition: types.hpp:586
Decimal open
Open price.
Definition: types.hpp:582
int64_t volume
Volume.
Definition: types.hpp:588
Decimal low
Low price.
Definition: types.hpp:584
Capital distribution.
Definition: types.hpp:798
Decimal large
Large order.
Definition: types.hpp:800
Decimal small
Small order.
Definition: types.hpp:804
Decimal medium
Medium order.
Definition: types.hpp:802
Capital distribution response.
Definition: types.hpp:809
int64_t timestamp
Time.
Definition: types.hpp:811
CapitalDistribution capital_in
Inflow capital data.
Definition: types.hpp:813
CapitalDistribution capital_out
Outflow capital data.
Definition: types.hpp:815
Capital flow line.
Definition: types.hpp:789
Decimal inflow
Inflow capital data.
Definition: types.hpp:791
int64_t timestamp
Time.
Definition: types.hpp:793
An request for create watchlist group.
Definition: types.hpp:857
std::string name
Group name.
Definition: types.hpp:859
std::vector< std::string > securities
Securities.
Definition: types.hpp:861
Definition: types.hpp:226
std::optional< Decimal > price
Price.
Definition: types.hpp:230
int32_t position
Position.
Definition: types.hpp:228
int64_t volume
Volume.
Definition: types.hpp:232
int64_t order_num
Number of orders.
Definition: types.hpp:234
Derivative type.
Definition: types.hpp:122
uint8_t value
Definition: types.hpp:123
Filing item.
Definition: types.hpp:1301
std::string description
Description.
Definition: types.hpp:1307
std::string file_name
File name.
Definition: types.hpp:1309
std::string id
Filing ID.
Definition: types.hpp:1303
std::string title
Title.
Definition: types.hpp:1305
std::vector< std::string > file_urls
File URLs.
Definition: types.hpp:1311
int64_t published_at
Published time (Unix timestamp)
Definition: types.hpp:1313
History market temperature response.
Definition: types.hpp:1292
Granularity granularity
Granularity.
Definition: types.hpp:1294
std::vector< MarketTemperature > records
Records.
Definition: types.hpp:1296
Intraday line.
Definition: types.hpp:707
Decimal avg_price
Definition: types.hpp:712
Decimal turnover
Definition: types.hpp:711
int64_t timestamp
Definition: types.hpp:709
Decimal price
Definition: types.hpp:708
int64_t volume
Definition: types.hpp:710
Issuer info.
Definition: types.hpp:748
int32_t issuer_id
Issuer ID.
Definition: types.hpp:750
std::string name_en
Issuer name (en)
Definition: types.hpp:754
std::string name_cn
Issuer name (zh-CN)
Definition: types.hpp:752
std::string name_hk
Issuer name (zh-HK)
Definition: types.hpp:756
Market temperature.
Definition: types.hpp:1264
int32_t temperature
Temperature value.
Definition: types.hpp:1266
int32_t valuation
Market valuation.
Definition: types.hpp:1270
std::string description
Temperature description.
Definition: types.hpp:1268
int32_t sentiment
Market sentiment.
Definition: types.hpp:1272
int64_t timestamp
Time.
Definition: types.hpp:1274
Market trading days.
Definition: types.hpp:780
std::vector< Date > half_trading_days
Half trading days.
Definition: types.hpp:784
std::vector< Date > trading_days
Trading days.
Definition: types.hpp:782
Market trading session.
Definition: types.hpp:771
std::vector< TradingSessionInfo > trade_session
Trading session.
Definition: types.hpp:775
Market market
Market.
Definition: types.hpp:773
Definition: types.hpp:727
Decimal strike_price
Strike price.
Definition: types.hpp:733
int32_t days_to_expiry
Definition: types.hpp:743
std::string symbol
Option contract code, in ticker.region format.
Definition: types.hpp:729
Date expiry_date
Expiry date, in US Eastern time.
Definition: types.hpp:731
OptionDirection direction
Contract direction.
Definition: types.hpp:735
OptionStandardAttr standard_attr
Definition: types.hpp:740
OptionExpiryCycleType option_type
Special expiration cycle of the contract.
Definition: types.hpp:737
Quote of option.
Definition: types.hpp:503
Decimal prev_close
Yesterday's close.
Definition: types.hpp:508
TradeStatus trade_status
Security trading status.
Definition: types.hpp:522
OptionDirection direction
Option direction.
Definition: types.hpp:538
int64_t open_interest
Number of open positions.
Definition: types.hpp:526
int64_t timestamp
Time of latest price.
Definition: types.hpp:516
Decimal contract_size
Contract size.
Definition: types.hpp:536
Decimal contract_multiplier
Contract multiplier.
Definition: types.hpp:532
Decimal turnover
Turnover.
Definition: types.hpp:520
Decimal strike_price
Strike price.
Definition: types.hpp:530
OptionType contract_type
Option type.
Definition: types.hpp:534
Date expiry_date
Exprity date.
Definition: types.hpp:528
int64_t volume
Volume.
Definition: types.hpp:518
Decimal low
Low.
Definition: types.hpp:514
Decimal last_done
Latest price.
Definition: types.hpp:506
Decimal historical_volatility
Underlying security historical volatility of the option.
Definition: types.hpp:540
Decimal high
High.
Definition: types.hpp:512
Decimal implied_volatility
Implied volatility.
Definition: types.hpp:524
std::string symbol
Security code.
Definition: types.hpp:504
Decimal open
Open.
Definition: types.hpp:510
std::string underlying_symbol
Underlying security symbol of the option.
Definition: types.hpp:542
Definition: types.hpp:1396
std::string symbol
Definition: types.hpp:1397
std::vector< OptionVolumeDailyStat > stats
Definition: types.hpp:1398
Definition: types.hpp:1382
int64_t total_open_interest
Definition: types.hpp:1390
std::string symbol
Definition: types.hpp:1383
int64_t put_open_interest
Definition: types.hpp:1388
double pc_oi
Definition: types.hpp:1392
int64_t put_volume
Definition: types.hpp:1386
double pc_vol
Definition: types.hpp:1391
Date date
Definition: types.hpp:1384
int64_t call_volume
Definition: types.hpp:1385
int64_t call_open_interest
Definition: types.hpp:1387
int64_t total_volume
Definition: types.hpp:1389
Definition: types.hpp:1375
std::string symbol
Definition: types.hpp:1376
int64_t call_volume
Definition: types.hpp:1377
int64_t put_volume
Definition: types.hpp:1378
Definition: types.hpp:694
std::string name_hk
Participant name (zh-HK)
Definition: types.hpp:702
std::string name_en
Participant name (en)
Definition: types.hpp:700
std::vector< int32_t > broker_ids
Broker IDs.
Definition: types.hpp:696
std::string name_cn
Participant name (zh-CN)
Definition: types.hpp:698
Quote of US pre/post market.
Definition: types.hpp:406
int64_t timestamp
Time of latest price.
Definition: types.hpp:410
Decimal low
Low.
Definition: types.hpp:418
Decimal turnover
Turnover.
Definition: types.hpp:414
Decimal high
High.
Definition: types.hpp:416
int64_t volume
Volume.
Definition: types.hpp:412
Decimal last_done
Latest price.
Definition: types.hpp:408
Decimal prev_close
Close of the last trade session.
Definition: types.hpp:420
Brokers message.
Definition: types.hpp:259
std::vector< Brokers > bid_brokers
Bid brokers.
Definition: types.hpp:265
std::vector< Brokers > ask_brokers
Ask brokers.
Definition: types.hpp:263
std::string symbol
Security code.
Definition: types.hpp:261
Candlestick updated message.
Definition: types.hpp:599
Period period
Period type.
Definition: types.hpp:603
bool is_confirmed
Is confirmed.
Definition: types.hpp:607
std::string symbol
Security code.
Definition: types.hpp:601
Candlestick candlestick
Candlestick.
Definition: types.hpp:605
Depth message.
Definition: types.hpp:239
std::vector< Depth > asks
Ask depth.
Definition: types.hpp:243
std::string symbol
Security code.
Definition: types.hpp:241
std::vector< Depth > bids
Bid depth.
Definition: types.hpp:245
Quote message.
Definition: types.hpp:198
Decimal high
High.
Definition: types.hpp:206
TradeStatus trade_status
Security trading status.
Definition: types.hpp:216
int64_t timestamp
Time of latest price.
Definition: types.hpp:210
Decimal last_done
Latest price.
Definition: types.hpp:202
Decimal turnover
Turnover.
Definition: types.hpp:214
int64_t current_volume
Increase volume between pushes.
Definition: types.hpp:220
int64_t volume
Volume.
Definition: types.hpp:212
Decimal urrent_turnover
Increase turnover between pushes.
Definition: types.hpp:222
TradeSession trade_session
Trade session.
Definition: types.hpp:218
Decimal low
Low.
Definition: types.hpp:208
Decimal open
Open.
Definition: types.hpp:204
std::string symbol
Security code.
Definition: types.hpp:200
Trades message.
Definition: types.hpp:569
std::string symbol
Security code.
Definition: types.hpp:571
std::vector< Trade > trades
Trades data.
Definition: types.hpp:573
Quote package detail.
Definition: types.hpp:1240
int64_t start_at
Start at.
Definition: types.hpp:1248
std::string description
Description.
Definition: types.hpp:1246
std::string key
Key.
Definition: types.hpp:1242
int64_t end_at
End at.
Definition: types.hpp:1250
std::string name
Name.
Definition: types.hpp:1244
Real-time quote.
Definition: types.hpp:879
Decimal high
High.
Definition: types.hpp:887
Decimal open
Open.
Definition: types.hpp:885
std::string symbol
Security code.
Definition: types.hpp:881
Decimal turnover
Turnover.
Definition: types.hpp:895
int64_t timestamp
Time of latest price.
Definition: types.hpp:891
int64_t volume
Volume.
Definition: types.hpp:893
Decimal last_done
Latest price.
Definition: types.hpp:883
TradeStatus trade_status
Security trading status.
Definition: types.hpp:897
Decimal low
Low.
Definition: types.hpp:889
Security brokers.
Definition: types.hpp:686
std::vector< Brokers > bid_brokers
Bid brokers.
Definition: types.hpp:690
std::vector< Brokers > ask_brokers
Ask brokers.
Definition: types.hpp:688
Security calc index response.
Definition: types.hpp:987
std::optional< Decimal > balance_point
Breakeven point.
Definition: types.hpp:1057
std::optional< Decimal > change_rate
Change ratio.
Definition: types.hpp:995
std::optional< Decimal > lower_strike_price
Lower bound price.
Definition: types.hpp:1033
std::optional< Date > expiry_date
Expiry date.
Definition: types.hpp:1027
std::optional< Decimal > theta
Definition: types.hpp:1069
std::optional< Decimal > conversion_ratio
Conversion ratio.
Definition: types.hpp:1055
std::optional< Decimal > leverage_ratio
Leverage ratio.
Definition: types.hpp:1053
std::optional< Decimal > five_day_change_rate
Five days change ratio.
Definition: types.hpp:1019
std::optional< int64_t > open_interest
Open interest.
Definition: types.hpp:1059
std::optional< Decimal > ten_day_change_rate
Ten days change ratio.
Definition: types.hpp:1021
std::optional< Decimal > volume_ratio
Volume ratio.
Definition: types.hpp:1011
std::string symbol
Security code.
Definition: types.hpp:989
std::optional< Decimal > call_price
Call price.
Definition: types.hpp:1047
std::optional< Decimal > turnover
Turnover.
Definition: types.hpp:999
std::optional< Decimal > warrant_delta
Warrant delta.
Definition: types.hpp:1045
std::optional< Decimal > ytd_change_rate
Year-to-date change ratio.
Definition: types.hpp:1001
std::optional< int64_t > volume
Volume.
Definition: types.hpp:997
std::optional< Decimal > capital_flow
Capital flow.
Definition: types.hpp:1007
std::optional< int64_t > outstanding_qty
Outstanding quantity.
Definition: types.hpp:1035
std::optional< Decimal > pe_ttm_ratio
PE (TTM)
Definition: types.hpp:1013
std::optional< Decimal > last_done
Latest price.
Definition: types.hpp:991
std::optional< Decimal > delta
Definition: types.hpp:1062
std::optional< Decimal > vega
Definition: types.hpp:1073
std::optional< Decimal > itm_otm
In/out of the bound.
Definition: types.hpp:1041
std::optional< Decimal > outstanding_ratio
Outstanding ratio.
Definition: types.hpp:1037
std::optional< Decimal > strike_price
Strike price.
Definition: types.hpp:1029
std::optional< Decimal > implied_volatility
Implied volatility.
Definition: types.hpp:1043
std::optional< Decimal > half_year_change_rate
Half year change ratio.
Definition: types.hpp:1023
std::optional< Decimal > amplitude
Amplitude.
Definition: types.hpp:1009
std::optional< Decimal > premium
Premium.
Definition: types.hpp:1039
std::optional< Decimal > effective_leverage
Effective leverage.
Definition: types.hpp:1051
std::optional< Decimal > turnover_rate
Turnover rate.
Definition: types.hpp:1003
std::optional< Decimal > upper_strike_price
Upper bound price.
Definition: types.hpp:1031
std::optional< Decimal > rho
Definition: types.hpp:1077
std::optional< Decimal > dividend_ratio_ttm
Dividend ratio (TTM)
Definition: types.hpp:1017
std::optional< Decimal > gamma
Definition: types.hpp:1065
std::optional< Decimal > change_value
Change value.
Definition: types.hpp:993
std::optional< Decimal > total_market_value
Total market value.
Definition: types.hpp:1005
std::optional< Decimal > to_call_price
Price interval from the call price.
Definition: types.hpp:1049
std::optional< Decimal > five_minutes_change_rate
Five minutes change ratio.
Definition: types.hpp:1025
std::optional< Decimal > pb_ratio
PB.
Definition: types.hpp:1015
Security depth.
Definition: types.hpp:677
std::vector< Depth > asks
Ask depth.
Definition: types.hpp:679
std::vector< Depth > bids
Bid depth.
Definition: types.hpp:681
Security.
Definition: types.hpp:329
std::string name_hk
Security name (zh-HK)
Definition: types.hpp:337
std::string symbol
Security code.
Definition: types.hpp:331
std::string name_cn
Security name (zh-CN)
Definition: types.hpp:333
std::string name_en
Security name (en)
Definition: types.hpp:335
Quote of securitity.
Definition: types.hpp:425
Decimal last_done
Latest price.
Definition: types.hpp:429
Decimal turnover
Turnover.
Definition: types.hpp:443
Decimal prev_close
Yesterday's close.
Definition: types.hpp:431
std::string symbol
Security code.
Definition: types.hpp:427
TradeStatus trade_status
Security trading status.
Definition: types.hpp:445
Decimal high
High.
Definition: types.hpp:435
std::optional< PrePostQuote > post_market_quote
Quote of US post market.
Definition: types.hpp:449
std::optional< PrePostQuote > pre_market_quote
Quote of US pre market.
Definition: types.hpp:447
int64_t volume
Volume.
Definition: types.hpp:441
std::optional< PrePostQuote > overnight_quote
Quote of US overnight market.
Definition: types.hpp:451
int64_t timestamp
Time of latest price.
Definition: types.hpp:439
Decimal open
Open.
Definition: types.hpp:433
Decimal low
Low.
Definition: types.hpp:437
The basic information of securities.
Definition: types.hpp:342
std::string currency
Trading currency.
Definition: types.hpp:354
int64_t hk_shares
HK shares (only HK stocks)
Definition: types.hpp:362
std::string symbol
Security code.
Definition: types.hpp:344
std::string name_cn
Security name (zh-CN)
Definition: types.hpp:346
int64_t total_shares
Total shares.
Definition: types.hpp:358
Decimal eps
Earnings per share.
Definition: types.hpp:364
std::string name_hk
Security name (zh-HK)
Definition: types.hpp:350
Decimal eps_ttm
Earnings per share (TTM)
Definition: types.hpp:366
Decimal dividend_yield
Dividend (per share), not the dividend yield (ratio).
Definition: types.hpp:370
SecurityBoard board
Board.
Definition: types.hpp:374
std::string exchange
Exchange which the security belongs to.
Definition: types.hpp:352
int32_t lot_size
Lot size.
Definition: types.hpp:356
DerivativeType stock_derivatives
Types of supported derivatives.
Definition: types.hpp:372
int64_t circulating_shares
Circulating shares.
Definition: types.hpp:360
std::string name_en
Security name (en)
Definition: types.hpp:348
Decimal bps
Net assets per share.
Definition: types.hpp:368
One short-position record, unified for US and HK markets.
Definition: types.hpp:1318
std::string timestamp
Trading date in RFC 3339 format.
Definition: types.hpp:1320
std::string close
Closing price.
Definition: types.hpp:1324
std::string days_to_cover
[US] Days-to-cover ratio
Definition: types.hpp:1330
std::string cost
[HK] Closing price (HK naming)
Definition: types.hpp:1336
std::string current_shares_short
[US] Number of short shares outstanding
Definition: types.hpp:1326
std::string rate
Short ratio.
Definition: types.hpp:1322
std::string balance
[HK] Short position balance
Definition: types.hpp:1334
std::string amount
[HK] Short sale amount (HKD)
Definition: types.hpp:1332
std::string avg_daily_share_volume
[US] Average daily share volume
Definition: types.hpp:1328
Short interest / positions response (HK or US).
Definition: types.hpp:1341
std::vector< ShortPositionsItem > data
Short position records.
Definition: types.hpp:1343
One short-trade record, unified for US and HK markets.
Definition: types.hpp:1348
std::string rate
Short ratio.
Definition: types.hpp:1352
std::string total_amount
[US] Total short amount
Definition: types.hpp:1360
std::string balance
[HK] Short position balance
Definition: types.hpp:1364
std::string amount
[HK] Short sale turnover amount (HKD)
Definition: types.hpp:1362
std::string close
Closing price.
Definition: types.hpp:1354
std::string timestamp
Trading date in RFC 3339 format.
Definition: types.hpp:1350
std::string ny_amount
[US] NYSE short sale volume
Definition: types.hpp:1358
std::string nus_amount
[US] NASDAQ short sale volume
Definition: types.hpp:1356
Short trade records response (HK or US).
Definition: types.hpp:1369
std::vector< ShortTradesItem > data
Short trade records.
Definition: types.hpp:1371
Subscription.
Definition: types.hpp:174
SubFlags sub_types
Subscription flags.
Definition: types.hpp:178
std::vector< Period > candlesticks
Candlesticks.
Definition: types.hpp:180
std::string symbol
Security code.
Definition: types.hpp:176
Trade.
Definition: types.hpp:558
TradeSession trade_session
Definition: types.hpp:564
Decimal price
Definition: types.hpp:559
int64_t timestamp
Definition: types.hpp:561
std::string trade_type
Definition: types.hpp:562
int64_t volume
Definition: types.hpp:560
TradeDirection direction
Definition: types.hpp:563
Definition: types.hpp:760
Time end_time
End trading time.
Definition: types.hpp:764
Time begin_time
Being trading time.
Definition: types.hpp:762
TradeSession trade_session
Trading session.
Definition: types.hpp:766
An request for update watchlist group.
Definition: types.hpp:866
int64_t id
Group id.
Definition: types.hpp:868
std::optional< std::vector< std::string > > securities
Securities.
Definition: types.hpp:872
std::optional< std::string > name
Group name.
Definition: types.hpp:870
SecuritiesUpdateMode mode
Securities Update Mode.
Definition: types.hpp:874
Warrant info.
Definition: types.hpp:1175
std::optional< Decimal > conversion_ratio
Conversion ratio.
Definition: types.hpp:1224
std::string name
Security name.
Definition: types.hpp:1181
std::optional< Decimal > to_call_price
Price interval from the call price.
Definition: types.hpp:1218
std::optional< Decimal > upper_strike_price
Upper strike price.
Definition: types.hpp:1200
WarrantType warrant_type
Warrant type.
Definition: types.hpp:1179
std::string symbol
Security code.
Definition: types.hpp:1177
int64_t volume
Volume.
Definition: types.hpp:1189
Decimal turnover
Turnover.
Definition: types.hpp:1191
std::optional< Decimal > implied_volatility
Implied volatility.
Definition: types.hpp:1212
Decimal change_value
Quote change.
Definition: types.hpp:1187
std::optional< Decimal > delta
Delta.
Definition: types.hpp:1214
std::optional< Decimal > balance_point
Breakeven point.
Definition: types.hpp:1226
std::optional< Decimal > call_price
Call price.
Definition: types.hpp:1216
int64_t outstanding_qty
Outstanding quantity.
Definition: types.hpp:1204
Decimal change_rate
Quote change rate.
Definition: types.hpp:1185
std::optional< Date > expiry_date
Definition: types.hpp:1196
WarrantStatus status
Status.
Definition: types.hpp:1228
Decimal leverage_ratio
Leverage ratio.
Definition: types.hpp:1222
Decimal last_done
Latest price.
Definition: types.hpp:1183
std::optional< Decimal > itm_otm
In/out of the bound.
Definition: types.hpp:1210
Decimal premium
Premium.
Definition: types.hpp:1208
std::optional< Decimal > strike_price
Strike price.
Definition: types.hpp:1198
std::optional< Decimal > effective_leverage
Effective leverage.
Definition: types.hpp:1220
std::optional< Decimal > lower_strike_price
Lower strike price.
Definition: types.hpp:1202
Decimal outstanding_ratio
Outstanding ratio.
Definition: types.hpp:1206
Quote of warrant.
Definition: types.hpp:629
Decimal strike_price
Strike price.
Definition: types.hpp:664
Date expiry_date
Exprity date.
Definition: types.hpp:652
Decimal open
Open.
Definition: types.hpp:636
Decimal turnover
Turnover.
Definition: types.hpp:646
int64_t volume
Volume.
Definition: types.hpp:644
WarrantType category
Warrant type.
Definition: types.hpp:662
Decimal low
Low.
Definition: types.hpp:640
TradeStatus trade_status
Security trading status.
Definition: types.hpp:648
Decimal upper_strike_price
Upper bound price.
Definition: types.hpp:666
int64_t outstanding_quantity
Outstanding quantity.
Definition: types.hpp:658
Decimal prev_close
Yesterday's close.
Definition: types.hpp:634
int64_t timestamp
Time of latest price.
Definition: types.hpp:642
Date last_trade_date
Last tradalbe date.
Definition: types.hpp:654
std::string symbol
Security code.
Definition: types.hpp:630
Decimal high
High.
Definition: types.hpp:638
Decimal lower_strike_price
Lower bound price.
Definition: types.hpp:668
Decimal last_done
Latest price.
Definition: types.hpp:632
Decimal conversion_ratio
Conversion ratio.
Definition: types.hpp:660
Decimal implied_volatility
Implied volatility.
Definition: types.hpp:650
Decimal outstanding_ratio
Outstanding ratio.
Definition: types.hpp:656
std::string underlying_symbol
Underlying security symbol of the warrant.
Definition: types.hpp:672
Decimal call_price
Call price.
Definition: types.hpp:670
Watchlist group.
Definition: types.hpp:835
int64_t id
Group id.
Definition: types.hpp:837
std::vector< WatchlistSecurity > securities
Securities.
Definition: types.hpp:841
std::string name
Group name.
Definition: types.hpp:839
Watchlist security.
Definition: types.hpp:820
std::string symbol
Security symbol.
Definition: types.hpp:822
std::optional< Decimal > watched_price
Watched price.
Definition: types.hpp:828
std::string name
Security name.
Definition: types.hpp:826
int64_t watched_at
Watched time.
Definition: types.hpp:830
Market market
Market.
Definition: types.hpp:824
Response for SharelistContext::detail.
Definition: types.hpp:4596
SharelistScopes scopes
Subscription scope flags for the current user.
Definition: types.hpp:4600
SharelistInfo sharelist
Sharelist info including constituent stocks.
Definition: types.hpp:4598
Sharelist metadata and constituent stocks.
Definition: types.hpp:4552
int64_t subscribers_count
Number of subscribers.
Definition: types.hpp:4562
int64_t created_at
Creation time (Unix timestamp)
Definition: types.hpp:4564
std::string this_year_chg
YTD change percentage.
Definition: types.hpp:4568
std::string description
Description.
Definition: types.hpp:4558
int64_t id
Sharelist ID.
Definition: types.hpp:4554
std::string cover
Cover image URL.
Definition: types.hpp:4560
std::vector< SharelistStock > stocks
Constituent stocks.
Definition: types.hpp:4572
int32_t sharelist_type
Sharelist type: 0=regular, 3=official, 4=industry.
Definition: types.hpp:4578
std::string name
Name.
Definition: types.hpp:4556
bool subscribed
Whether the current user is subscribed.
Definition: types.hpp:4574
std::string creator
Creator info (serialised JSON)
Definition: types.hpp:4570
int64_t edited_at
Last stock edit time (Unix timestamp)
Definition: types.hpp:4566
std::string industry_code
Industry code (for industry sharelists)
Definition: types.hpp:4580
std::string chg
Day change percentage.
Definition: types.hpp:4576
Response for SharelistContext::list and SharelistContext::popular.
Definition: types.hpp:4585
std::vector< SharelistInfo > sharelists
User's own and followed sharelists.
Definition: types.hpp:4587
std::vector< SharelistInfo > subscribed_sharelists
Subscribed sharelists (may be empty in popular response)
Definition: types.hpp:4589
std::string tail_mark
Pagination cursor for the subscribed list.
Definition: types.hpp:4591
Subscription scope flags for a sharelist.
Definition: types.hpp:4543
bool subscription
Whether the current user is subscribed to this sharelist.
Definition: types.hpp:4545
bool is_self
Whether the current user is the creator of this sharelist.
Definition: types.hpp:4547
A security constituent of a sharelist.
Definition: types.hpp:4520
std::string unread_change_log_category
Unread change log category.
Definition: types.hpp:4532
std::string name
Security name.
Definition: types.hpp:4524
std::string market
Market, e.g. "HK".
Definition: types.hpp:4526
std::optional< std::string > change
Day change percentage (absent when quote unavailable)
Definition: types.hpp:4534
std::string intro
Brief description.
Definition: types.hpp:4530
std::string code
Ticker code.
Definition: types.hpp:4528
std::string symbol
Security symbol.
Definition: types.hpp:4522
std::optional< std::string > last_done
Latest price (absent when quote unavailable)
Definition: types.hpp:4536
std::optional< int32_t > trade_status
Trade status code (absent when quote unavailable)
Definition: types.hpp:4538
Account balance.
Definition: types.hpp:2061
Decimal total_cash
Total cash.
Definition: types.hpp:2063
Decimal max_finance_amount
Maximum financing amount.
Definition: types.hpp:2065
std::vector< FrozenTransactionFee > frozen_transaction_fees
Frozen transaction fees.
Definition: types.hpp:2085
Decimal maintenance_margin
Maintenance margin.
Definition: types.hpp:2081
Decimal net_assets
Net assets.
Definition: types.hpp:2077
Decimal init_margin
Initial margin.
Definition: types.hpp:2079
std::string currency
Currency.
Definition: types.hpp:2073
Decimal buy_power
Buy power.
Definition: types.hpp:2083
Decimal margin_call
Margin call.
Definition: types.hpp:2071
Decimal remaining_finance_amount
Remaining financing amount.
Definition: types.hpp:2067
int32_t risk_level
Risk control level.
Definition: types.hpp:2069
std::vector< CashInfo > cash_infos
Cash details.
Definition: types.hpp:2075
All executions response.
Definition: types.hpp:1473
bool has_more
Has more records.
Definition: types.hpp:1475
std::vector< Execution > trades
Executions.
Definition: types.hpp:1477
Attached order detail.
Definition: types.hpp:1623
Decimal quantity
Definition: types.hpp:1627
std::optional< OutsideRTH > force_only_rth
Definition: types.hpp:1640
Decimal executed_amount
Definition: types.hpp:1636
std::string counter_id
Definition: types.hpp:1634
bool withdrawn
Definition: types.hpp:1631
std::optional< Decimal > trigger_price
Definition: types.hpp:1626
std::optional< OutsideRTH > activate_rth
Definition: types.hpp:1643
OrderType activate_order_type
Definition: types.hpp:1642
std::string order_id
Definition: types.hpp:1624
int64_t updated_at
Definition: types.hpp:1630
std::optional< Decimal > executed_price
Definition: types.hpp:1639
Decimal executed_qty
Definition: types.hpp:1628
AttachedOrderType attached_type_display
Definition: types.hpp:1625
std::optional< Date > gtd
Definition: types.hpp:1632
TimeInForceType time_in_force
Definition: types.hpp:1633
std::optional< Decimal > submit_price
Definition: types.hpp:1644
OrderTag tag
Definition: types.hpp:1637
std::optional< TriggerStatus > trigger_status
Definition: types.hpp:1635
int64_t submitted_at
Definition: types.hpp:1638
bool reviewed
Definition: types.hpp:1641
OrderStatus status
Definition: types.hpp:1629
Cash flow.
Definition: types.hpp:2114
std::optional< std::string > symbol
Associated Stock code information.
Definition: types.hpp:2128
std::string transaction_flow_name
Cash flow name.
Definition: types.hpp:2116
std::string description
Cash flow description.
Definition: types.hpp:2130
int64_t business_time
Business time.
Definition: types.hpp:2126
CashFlowDirection direction
Outflow direction.
Definition: types.hpp:2118
Decimal balance
Cash amount.
Definition: types.hpp:2122
BalanceType business_type
Balance type.
Definition: types.hpp:2120
std::string currency
Cash currency.
Definition: types.hpp:2124
Cash info.
Definition: types.hpp:2039
Decimal frozen_cash
Frozen cash.
Definition: types.hpp:2045
Decimal settling_cash
Cash to be settled.
Definition: types.hpp:2047
Decimal withdraw_cash
Withdraw cash.
Definition: types.hpp:2041
Decimal available_cash
Available cash.
Definition: types.hpp:2043
std::string currency
Currency.
Definition: types.hpp:2049
Options for estimate maximum purchase quantity.
Definition: types.hpp:2420
std::string symbol
Security code.
Definition: types.hpp:2422
OrderType order_type
Order type.
Definition: types.hpp:2424
bool fractional_shares
Get the maximum fractional share buying power.
Definition: types.hpp:2435
std::optional< Decimal > price
Estimated order price.
Definition: types.hpp:2428
OrderSide side
Order side.
Definition: types.hpp:2426
std::optional< std::string > currency
Settlement currency.
Definition: types.hpp:2430
std::optional< std::string > order_id
Definition: types.hpp:2433
Response for estimate maximum purchase quantity.
Definition: types.hpp:2440
Decimal margin_max_qty
Margin available quantity.
Definition: types.hpp:2444
Decimal cash_max_qty
Cash available quantity.
Definition: types.hpp:2442
Exexution.
Definition: types.hpp:1425
Decimal price
Definition: types.hpp:1431
Decimal quantity
Definition: types.hpp:1430
OrderSide side
Order side.
Definition: types.hpp:1433
std::string trade_id
Definition: types.hpp:1427
std::string symbol
Definition: types.hpp:1428
std::string order_id
Definition: types.hpp:1426
int64_t trade_done_at
Definition: types.hpp:1429
Frozen transaction fee.
Definition: types.hpp:2054
std::string currency
Definition: types.hpp:2055
Decimal frozen_transaction_fee
Definition: types.hpp:2056
Fund position channel.
Definition: types.hpp:2185
std::string account_channel
Account type.
Definition: types.hpp:2187
std::vector< FundPosition > positions
Fund positions.
Definition: types.hpp:2189
Fund position.
Definition: types.hpp:2166
Decimal holding_units
Holding units.
Definition: types.hpp:2180
std::string currency
Currency.
Definition: types.hpp:2176
std::string symbol_name
Fund name.
Definition: types.hpp:2174
Decimal current_net_asset_value
Current equity.
Definition: types.hpp:2170
int64_t net_asset_value_day
Current equity time.
Definition: types.hpp:2172
Decimal cost_net_asset_value
Net cost.
Definition: types.hpp:2178
std::string symbol
Fund ISIN code.
Definition: types.hpp:2168
Fund positions response.
Definition: types.hpp:2194
std::vector< FundPositionChannel > channels
Channels.
Definition: types.hpp:2196
Options for get all executions request.
Definition: types.hpp:1458
std::optional< uint64_t > page
Page number.
Definition: types.hpp:1468
std::optional< int64_t > start_at
Start time.
Definition: types.hpp:1464
std::optional< std::string > order_id
Order id.
Definition: types.hpp:1462
std::optional< int64_t > end_at
End time.
Definition: types.hpp:1466
std::optional< std::string > symbol
Security code.
Definition: types.hpp:1460
Options for submit order request.
Definition: types.hpp:2135
int64_t end_at
End time.
Definition: types.hpp:2139
std::optional< uintptr_t > page
Page number.
Definition: types.hpp:2145
int64_t start_at
Start time.
Definition: types.hpp:2137
std::optional< uintptr_t > size
Page size.
Definition: types.hpp:2147
std::optional< BalanceType > business_type
Business type.
Definition: types.hpp:2141
std::optional< std::string > symbol
Security symbol.
Definition: types.hpp:2143
Options for get fund positions request.
Definition: types.hpp:2152
std::optional< std::vector< std::string > > symbols
Fund symbols.
Definition: types.hpp:2154
Options for get history executions request.
Definition: types.hpp:1438
std::optional< std::string > symbol
Security code.
Definition: types.hpp:1444
std::optional< int64_t > end_at
End time.
Definition: types.hpp:1442
std::optional< int64_t > start_at
Start time.
Definition: types.hpp:1440
Options for get history orders request.
Definition: types.hpp:1890
std::optional< int64_t > end_at
End time.
Definition: types.hpp:1902
std::optional< OrderSide > side
Order side.
Definition: types.hpp:1896
std::optional< Market > market
Market.
Definition: types.hpp:1898
std::optional< std::string > symbol
Security symbol.
Definition: types.hpp:1892
std::optional< std::vector< OrderStatus > > status
Order status.
Definition: types.hpp:1894
std::optional< int64_t > start_at
Start time.
Definition: types.hpp:1900
Options for get stock positions request.
Definition: types.hpp:2159
std::optional< std::vector< std::string > > symbols
Stock symbols.
Definition: types.hpp:2161
Options for get today executions request.
Definition: types.hpp:1449
std::optional< std::string > order_id
Order id.
Definition: types.hpp:1453
std::optional< std::string > symbol
Security code.
Definition: types.hpp:1451
Options for get today orders request.
Definition: types.hpp:1907
std::optional< std::string > symbol
Security symbol.
Definition: types.hpp:1909
std::optional< bool > is_attached
Whether to include attached orders.
Definition: types.hpp:1919
std::optional< std::string > order_id
Order id.
Definition: types.hpp:1917
std::optional< std::vector< OrderStatus > > status
Order status.
Definition: types.hpp:1911
std::optional< Market > market
Market.
Definition: types.hpp:1915
std::optional< OrderSide > side
Order side.
Definition: types.hpp:1913
Margin ratio.
Definition: types.hpp:2239
Decimal mm_factor
Maintain the initial margin ratio.
Definition: types.hpp:2243
Decimal im_factor
Initial margin ratio.
Definition: types.hpp:2241
Decimal fm_factor
Forced close-out margin ratio.
Definition: types.hpp:2245
Multi-leg strategy information.
Definition: types.hpp:1749
std::string code
Multi-leg combination code.
Definition: types.hpp:1757
std::string multileg_id
Multi-leg combination ID.
Definition: types.hpp:1755
std::vector< MultiLegOrderLeg > legs
Legs of the combination order.
Definition: types.hpp:1759
MultiLegStrategy strategy
Multi-leg strategy.
Definition: types.hpp:1751
std::string strategy_name
Strategy name.
Definition: types.hpp:1753
A leg of a multi-leg combination order.
Definition: types.hpp:1730
std::optional< Date > expire_date
Option expiry date.
Definition: types.hpp:1742
ContractDirection contract_direction
Contract type.
Definition: types.hpp:1744
MultiLegPosition position
Position direction.
Definition: types.hpp:1736
Decimal ratio_quantity
Leg ratio quantity.
Definition: types.hpp:1738
OrderSide side
Order side.
Definition: types.hpp:1734
std::optional< Decimal > strike_price
Strike price.
Definition: types.hpp:1740
std::string symbol
Option symbol, in ticker.region format.
Definition: types.hpp:1732
Order charge detail.
Definition: types.hpp:2319
std::string currency
Settlement currency.
Definition: types.hpp:2323
std::vector< OrderChargeItem > items
Order charge items.
Definition: types.hpp:2325
Decimal total_amount
Total charges amount.
Definition: types.hpp:2321
Order charge fee.
Definition: types.hpp:2295
Decimal amount
Charge amount.
Definition: types.hpp:2301
std::string currency
Charge currency.
Definition: types.hpp:2303
std::string code
Charge code.
Definition: types.hpp:2297
std::string name
Charge name.
Definition: types.hpp:2299
Order charge item.
Definition: types.hpp:2308
std::string name
Charge category name.
Definition: types.hpp:2312
std::vector< OrderChargeFee > fees
Charge details.
Definition: types.hpp:2314
ChargeCategoryCode code
Charge category code.
Definition: types.hpp:2310
Order detail.
Definition: types.hpp:2330
int64_t submitted_at
Submitted time.
Definition: types.hpp:2346
std::optional< std::string > free_currency
Commission-free currency.
Definition: types.hpp:2394
std::optional< TriggerStatus > trigger_status
Conditional order trigger status.
Definition: types.hpp:2376
std::optional< OutsideRTH > outside_rth
Enable or disable outside regular trading hours.
Definition: types.hpp:2380
Decimal quantity
Submitted quantity.
Definition: types.hpp:2338
std::optional< std::string > deductions_currency
Deduction currency.
Definition: types.hpp:2400
std::string currency
Currency.
Definition: types.hpp:2378
OrderStatus status
Order status.
Definition: types.hpp:2334
std::optional< int32_t > trigger_count
Trigger count.
Definition: types.hpp:2384
OrderSide side
Order side.
Definition: types.hpp:2348
std::optional< Decimal > last_done
Last done.
Definition: types.hpp:2354
std::optional< Decimal > monitor_price
Monitor price.
Definition: types.hpp:2386
std::string msg
Rejected Message or remark.
Definition: types.hpp:2358
std::optional< int64_t > updated_at
Last updated time.
Definition: types.hpp:2366
std::optional< Decimal > platform_deducted_amount
Platform deduction amount.
Definition: types.hpp:2404
CommissionFreeStatus free_status
Commission-free Status.
Definition: types.hpp:2390
std::optional< int32_t > limit_depth_level
Limit depth level.
Definition: types.hpp:2382
std::string remark
Remark.
Definition: types.hpp:2388
OrderTag tag
Order tag.
Definition: types.hpp:2360
std::string order_id
Order ID.
Definition: types.hpp:2332
std::optional< Date > expire_date
Long term order expire date.
Definition: types.hpp:2364
std::optional< int64_t > trigger_at
Conditional order trigger time.
Definition: types.hpp:2368
std::optional< Decimal > free_amount
Commission-free amount.
Definition: types.hpp:2392
DeductionStatus deductions_status
Deduction status.
Definition: types.hpp:2396
std::string symbol
Security code.
Definition: types.hpp:2350
std::optional< Decimal > trigger_price
LIT / MIT Order Trigger Price
Definition: types.hpp:2356
std::vector< AttachedOrderDetail > attached_orders
Attached orders.
Definition: types.hpp:2412
std::string stock_name
Stock name.
Definition: types.hpp:2336
OrderType order_type
Order type.
Definition: types.hpp:2352
DeductionStatus platform_deducted_status
Platform fee deduction status.
Definition: types.hpp:2402
std::optional< Decimal > limit_offset
TSLPAMT / TSLPPCT order limit offset amount
Definition: types.hpp:2374
std::optional< MultiLegInfo > multi_leg
Definition: types.hpp:2415
std::optional< Decimal > deductions_amount
Deduction amount.
Definition: types.hpp:2398
TimeInForceType time_in_force
Time in force type.
Definition: types.hpp:2362
std::optional< Decimal > trailing_percent
TSMPCT / TSLPPCT order trailing percent
Definition: types.hpp:2372
Decimal executed_quantity
Executed quantity.
Definition: types.hpp:2340
std::optional< Decimal > price
Submitted price.
Definition: types.hpp:2342
std::vector< OrderHistoryDetail > history
Order history details.
Definition: types.hpp:2408
std::optional< std::string > platform_deducted_currency
Platform deduction currency.
Definition: types.hpp:2406
std::optional< Decimal > executed_price
Executed price.
Definition: types.hpp:2344
std::optional< Decimal > trailing_amount
TSMAMT / TSLPAMT order trailing amount
Definition: types.hpp:2370
std::optional< OrderChargeDetail > charge_detail
Order charges (maybe null)
Definition: types.hpp:2410
Order history detail.
Definition: types.hpp:2278
Decimal quantity
Definition: types.hpp:2284
Decimal price
Definition: types.hpp:2281
std::string msg
Execution or error message.
Definition: types.hpp:2288
OrderStatus status
Order status.
Definition: types.hpp:2286
int64_t time
Occurrence time.
Definition: types.hpp:2290
Order.
Definition: types.hpp:1764
Decimal quantity
Submitted quantity.
Definition: types.hpp:1772
int64_t submitted_at
Submitted time.
Definition: types.hpp:1780
std::optional< Decimal > trailing_amount
TSMAMT / TSLPAMT order trailing amount
Definition: types.hpp:1804
OrderTag tag
Order tag.
Definition: types.hpp:1794
std::optional< Decimal > trigger_price
LIT / MIT Order Trigger Price
Definition: types.hpp:1790
OrderStatus status
Order status.
Definition: types.hpp:1768
std::string currency
Currency.
Definition: types.hpp:1812
TimeInForceType time_in_force
Time in force type.
Definition: types.hpp:1796
std::optional< Decimal > monitor_price
Monitor price.
Definition: types.hpp:1820
std::string stock_name
Stock name.
Definition: types.hpp:1770
std::optional< Date > expire_date
Long term order expire date.
Definition: types.hpp:1798
OrderSide side
Order side.
Definition: types.hpp:1782
std::optional< Decimal > executed_price
Executed price.
Definition: types.hpp:1778
std::string symbol
Security code.
Definition: types.hpp:1784
std::optional< Decimal > price
Submitted price.
Definition: types.hpp:1776
std::optional< MultiLegInfo > multi_leg
Definition: types.hpp:1827
std::optional< Decimal > trailing_percent
TSMPCT / TSLPPCT order trailing percent
Definition: types.hpp:1806
std::string msg
Rejected Message or remark.
Definition: types.hpp:1792
std::optional< TriggerStatus > trigger_status
Conditional order trigger status.
Definition: types.hpp:1810
std::optional< Decimal > last_done
Last done.
Definition: types.hpp:1788
std::string order_id
Order ID.
Definition: types.hpp:1766
std::optional< int64_t > updated_at
Last updated time.
Definition: types.hpp:1800
std::optional< OutsideRTH > outside_rth
Enable or disable outside regular trading hours.
Definition: types.hpp:1814
OrderType order_type
Order type.
Definition: types.hpp:1786
std::optional< int32_t > limit_depth_level
Limit depth level.
Definition: types.hpp:1816
std::string remark
Remark.
Definition: types.hpp:1822
Decimal executed_quantity
Executed quantity.
Definition: types.hpp:1774
std::optional< Decimal > limit_offset
TSLPAMT / TSLPPCT order limit offset amount
Definition: types.hpp:1808
std::optional< int64_t > trigger_at
Conditional order trigger time.
Definition: types.hpp:1802
std::vector< AttachedOrderDetail > attached_orders
Attached orders.
Definition: types.hpp:1824
std::optional< int32_t > trigger_count
Trigger count.
Definition: types.hpp:1818
Grid trading master-order changed message.
Definition: types.hpp:2450
std::string current_base_price
Current base price.
Definition: types.hpp:2462
std::string grid_order_type_down
Buy-side order type when depth is 0.
Definition: types.hpp:2480
std::string trigger_quantity
Quantity per trigger.
Definition: types.hpp:2470
std::string submitted_base_price
Submitted base price.
Definition: types.hpp:2460
std::string suspend_reason
Suspend reason, if any.
Definition: types.hpp:2458
int32_t time_in_force
Time in force (0 = Day, 1 = GTC, 6 = GTD)
Definition: types.hpp:2474
std::string symbol
Security symbol (e.g. 700.HK)
Definition: types.hpp:2456
int32_t rth
Regular trading hours flag.
Definition: types.hpp:2476
std::string order_id
Grid master order ID.
Definition: types.hpp:2452
std::string status
Order status.
Definition: types.hpp:2454
std::string upper_limit_price
Upper price bound.
Definition: types.hpp:2464
std::string settlement_currency
Settlement currency.
Definition: types.hpp:2472
int32_t trigger_price_type
Trigger price type.
Definition: types.hpp:2468
std::string grid_order_type_up
Sell-side order type when depth is 0.
Definition: types.hpp:2478
std::string lower_limit_price
Lower price bound.
Definition: types.hpp:2466
Order changed message.
Definition: types.hpp:1832
std::string order_id
Order ID.
Definition: types.hpp:1850
Decimal submitted_quantity
Submitted quantity.
Definition: types.hpp:1838
int64_t submitted_at
Submitted time.
Definition: types.hpp:1856
std::optional< Decimal > trailing_percent
Trailing percent.
Definition: types.hpp:1872
std::optional< Decimal > trailing_amount
Trailing amount.
Definition: types.hpp:1870
std::string currency
Currency.
Definition: types.hpp:1852
std::optional< Decimal > executed_price
Executed price.
Definition: types.hpp:1848
std::string stock_name
Stock name.
Definition: types.hpp:1836
std::optional< Decimal > trigger_price
Order trigger price.
Definition: types.hpp:1860
OrderType order_type
Order type.
Definition: types.hpp:1842
std::optional< Decimal > last_price
Last price.
Definition: types.hpp:1880
std::optional< TriggerStatus > trigger_status
Conditional order trigger status.
Definition: types.hpp:1866
Decimal executed_quantity
Executed quantity.
Definition: types.hpp:1846
std::string msg
Rejected message or remark.
Definition: types.hpp:1862
int64_t updated_at
Last updated time.
Definition: types.hpp:1858
OrderSide side
Order side.
Definition: types.hpp:1834
std::optional< Decimal > limit_offset
Limit offset amount.
Definition: types.hpp:1874
OrderStatus status
Order status.
Definition: types.hpp:1854
std::string remark
Remark message.
Definition: types.hpp:1882
std::optional< MultiLegInfo > multi_leg
Definition: types.hpp:1885
Decimal submitted_price
Submitted price.
Definition: types.hpp:1844
OrderTag tag
Order tag.
Definition: types.hpp:1864
std::optional< int64_t > trigger_at
Conditional order trigger time.
Definition: types.hpp:1868
std::string symbol
Order symbol.
Definition: types.hpp:1840
std::optional< Decimal > last_share
Last share.
Definition: types.hpp:1878
std::string account_no
Account no.
Definition: types.hpp:1876
Replace attached order params.
Definition: types.hpp:1663
std::optional< int64_t > expire_time
Definition: types.hpp:1668
std::optional< Decimal > stop_loss_submit_price
Definition: types.hpp:1671
std::optional< Decimal > stop_loss_price
Definition: types.hpp:1666
std::optional< bool > cancel_all_attached
Definition: types.hpp:1675
std::optional< int64_t > main_id
Definition: types.hpp:1676
std::optional< OrderType > activate_order_type
Definition: types.hpp:1669
std::optional< Decimal > market_price
Definition: types.hpp:1678
std::optional< TimeInForceType > time_in_force
Definition: types.hpp:1667
std::optional< int64_t > stop_loss_id
Definition: types.hpp:1674
std::optional< Decimal > profit_taker_submit_price
Definition: types.hpp:1670
AttachedOrderType attached_order_type
Definition: types.hpp:1664
std::optional< Decimal > profit_taker_price
Definition: types.hpp:1665
std::optional< int64_t > profit_taker_id
Definition: types.hpp:1673
std::optional< OutsideRTH > activate_rth
Definition: types.hpp:1672
std::optional< Decimal > quantity
Definition: types.hpp:1677
Options for replace order request.
Definition: types.hpp:1924
std::string order_id
Order ID.
Definition: types.hpp:1926
std::optional< int32_t > limit_depth_level
Limit depth level.
Definition: types.hpp:1940
std::optional< Decimal > monitor_price
Monitor price.
Definition: types.hpp:1944
std::optional< Decimal > price
Price.
Definition: types.hpp:1930
std::optional< Decimal > trigger_price
Trigger price.
Definition: types.hpp:1932
Decimal quantity
Quantity.
Definition: types.hpp:1928
std::optional< int32_t > trigger_count
Trigger count.
Definition: types.hpp:1942
std::optional< Decimal > trailing_percent
Trailing percent.
Definition: types.hpp:1938
std::optional< Decimal > trailing_amount
Trailing amount.
Definition: types.hpp:1936
std::optional< Decimal > limit_offset
Limit offset.
Definition: types.hpp:1934
std::optional< std::string > remark
Remark.
Definition: types.hpp:1946
std::optional< ReplaceAttachedParams > attached_params
Attached order params.
Definition: types.hpp:1948
Stock position channel.
Definition: types.hpp:2223
std::string account_channel
Account type.
Definition: types.hpp:2225
std::vector< StockPosition > positions
Stock positions.
Definition: types.hpp:2227
Stock position.
Definition: types.hpp:2201
std::optional< Decimal > init_quantity
Initial position before market opening.
Definition: types.hpp:2218
Decimal quantity
The number of holdings.
Definition: types.hpp:2207
std::string symbol
Stock code.
Definition: types.hpp:2203
std::string symbol_name
Stock name.
Definition: types.hpp:2205
Decimal available_quantity
Available quantity.
Definition: types.hpp:2209
Decimal cost_price
Definition: types.hpp:2214
Market market
Market.
Definition: types.hpp:2216
std::string currency
Currency.
Definition: types.hpp:2211
Stock positions response.
Definition: types.hpp:2232
std::vector< StockPositionChannel > channels
Channels.
Definition: types.hpp:2234
Submit attached order params.
Definition: types.hpp:1649
std::optional< OrderType > activate_order_type
Definition: types.hpp:1655
std::optional< int64_t > expire_time
Definition: types.hpp:1654
std::optional< Decimal > profit_taker_submit_price
Definition: types.hpp:1656
std::optional< TimeInForceType > time_in_force
Definition: types.hpp:1653
AttachedOrderType attached_order_type
Definition: types.hpp:1650
std::optional< Decimal > stop_loss_submit_price
Definition: types.hpp:1657
std::optional< Decimal > stop_loss_price
Definition: types.hpp:1652
std::optional< Decimal > profit_taker_price
Definition: types.hpp:1651
std::optional< OutsideRTH > activate_rth
Definition: types.hpp:1658
A leg of a multi-leg combination order to submit.
Definition: types.hpp:2004
Decimal ratio_quantity
Definition: types.hpp:2011
std::string symbol
Option symbol, in ticker.region format (e.g. QQQ260731C764000.US)
Definition: types.hpp:2006
Options for submit multi-leg order request.
Definition: types.hpp:2016
std::optional< std::string > remark
Remark (Maximum 255 characters)
Definition: types.hpp:2030
Decimal submitted_quantity
Submitted quantity (number of combinations)
Definition: types.hpp:2022
std::optional< std::string > client_request_id
Definition: types.hpp:2034
MultiLegStrategy strategy
Multi-leg strategy.
Definition: types.hpp:2024
std::vector< SubmitMultiLegOrderLeg > legs
Legs of the combination order.
Definition: types.hpp:2026
std::optional< Decimal > submitted_price
Submitted price (required for limit order types such as LO)
Definition: types.hpp:2028
OrderSide side
Order side.
Definition: types.hpp:2018
OrderType order_type
Order type.
Definition: types.hpp:2020
Options for submit order request.
Definition: types.hpp:1953
std::optional< Decimal > trailing_percent
Trailing percent (TSLPPCT / TSMAPCT Required)
Definition: types.hpp:1973
std::optional< int32_t > limit_depth_level
Limit depth level.
Definition: types.hpp:1980
std::optional< std::string > client_request_id
Definition: types.hpp:1990
std::optional< int32_t > trigger_count
Trigger count.
Definition: types.hpp:1982
OrderType order_type
Order type.
Definition: types.hpp:1957
TimeInForceType time_in_force
Time in force type.
Definition: types.hpp:1963
std::optional< std::string > remark
Remark (Maximum 64 characters)
Definition: types.hpp:1986
OrderSide side
Order side.
Definition: types.hpp:1959
std::optional< Decimal > limit_offset
Limit offset amount (TSLPAMT / TSLPPCT Required)
Definition: types.hpp:1969
std::optional< Decimal > submitted_price
Submitted price.
Definition: types.hpp:1965
std::optional< Decimal > trailing_amount
Trailing amount (TSLPAMT / TSMAMT Required)
Definition: types.hpp:1971
std::string symbol
Security symbol.
Definition: types.hpp:1955
std::optional< Decimal > monitor_price
Monitor price.
Definition: types.hpp:1984
std::optional< SubmitAttachedParams > attached_params
Attached order params.
Definition: types.hpp:1992
std::optional< Decimal > trigger_price
Trigger price (LIT / MIT Required)
Definition: types.hpp:1967
std::optional< OutsideRTH > outside_rth
Enable or disable outside regular trading hours.
Definition: types.hpp:1978
std::optional< Date > expire_date
Definition: types.hpp:1976
Decimal submitted_quantity
Submitted price.
Definition: types.hpp:1961
Response for submit order request.
Definition: types.hpp:1997
std::string order_id
Order id.
Definition: types.hpp:1999