longbridge/longbridge-mcp

Filter by currency code (e.g. "USD", "HKD"). Omit to return all currencies.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of K-lines to return (default: 100)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

K-line period: "1m", "5m", "15m", "30m", "60m", "day" (default), "week", "month", "year"

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Alert condition: "price_rise", "price_fall", "percent_rise", "percent_fall"

Alert frequency: "once" (trigger once then disable), "daily" (once per day), "every" (alert every time condition is met)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Threshold price or percentage value

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Alert indicator id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Alert indicator id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Alert indicator id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of results to return (default: 50, max: 100)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market code: HK, US, CN, SG

Filter to a specific symbol, e.g. "700.HK" or "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Period: "rct_1" (1 day, default), "rct_5" (5 days), "rct_20" (20 days), "rct_60" (60 days)

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Broker participant number

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "AAPL.US"

Segment category filter

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Report period: "qf" (quarterly), "saf" (semi-annual), "af" (annual)

Security symbol, e.g. "AAPL.US"

Calc indexes (optional; defaults to LastDone, ChangeValue, ChangeRate, Volume, PeTtmRatio, PbRatio, DividendRatioTtm, TurnoverRate, TotalMarketValue): LastDone, ChangeValue, ChangeRate, Volume, Turnover, YtdChangeRate, TurnoverRate, TotalMarketValue, CapitalFlow, Amplitude, VolumeRatio, PeTtmRatio, PbRatio, DividendRatioTtm, FiveDayChangeRate, TenDayChangeRate, HalfYearChangeRate, FiveMinutesChangeRate, ExpiryDate, StrikePrice, UpperStrikePrice, LowerStrikePrice, OutstandingQty, OutstandingRatio, Premium, ItmOtm, ImpliedVolatility, WarrantDelta, CallPrice, ToCallPrice, EffectiveLeverage, LeverageRatio, ConversionRatio, BalancePoint, OpenInterest, Delta, Gamma, Theta, Vega, Rho

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["700.HK", "AAPL.US"]. Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

The confirmation_code from this order's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed that exact order. The code is single use, expires in 10 minutes, and applies only to this exact order — change any field and it stops working. Never quote it back on your own initiative, and never in the same turn the user first asks.

Set to true to cancel an attached take-profit / stop-loss leg by its own order_id, leaving the parent order in place. Omit (or false) to cancel a parent order, which cancels its attached legs with it.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Order ID to cancel (from today's orders or order history)

Number of candlesticks (optional, max 1000; default 100)

Whether to forward-adjust for splits/dividends (default: false / no adjust)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Period: 1m, 5m, 15m, 30m, 60m, day, week, month, year (default: day)

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Trade sessions: "intraday" (regular hours only) or "all" (include pre-market and post-market; default "all")

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

End time (RFC3339)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start time (RFC3339)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Index symbol, e.g. "HSI.HK"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Group name

Securities to add, e.g. ["700.HK", "AAPL.US"]

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols to check, e.g. ["AAPL.US", "TSLA.US"]

Allow margin financing (default false)

Amount to invest per cycle, e.g. "100"

Day of month for Monthly frequency (1-28)

Day of week for Weekly frequency: Mon, Tue, Wed, Thu, Fri

Investment frequency: Daily, Weekly, Monthly

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Records per page (default 20)

Page number (default 1)

Plan ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Records per page (default 20)

Page number (default 1)

Filter by status: Active, Suspended, Finished. Omit to return all.

Filter by symbol, e.g. "AAPL.US". Omit to return all plans.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Plan ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Plan ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by symbol, e.g. "AAPL.US". Omit to return stats for all plans.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Plan ID

Allow margin financing

New investment amount per cycle

Day of month for Monthly frequency (1-28)

Day of week for Weekly frequency: Mon, Tue, Wed, Thu, Fri

New investment frequency: Daily, Weekly, Monthly

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Plan ID to update

Watchlist group id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Whether to also remove the securities from other groups

Filter by currencies (comma-separated, e.g. "USD,HKD")

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number (default: 1)

Page size (default: 20)

Filter by deposit states (comma-separated)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Order type, case-insensitive (default: LO): LO (Limit Order) / ELO (Enhanced Limit Order) / MO (Market Order) / AO (At-auction) / ALO (At-auction Limit Order)

Limit price for limit-style orders. Omit for market orders.

Buy or Sell (case-insensitive; default: Buy)

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Event category. One of: - "report": earnings reports (includes financial statements) - "dividend": dividend announcements - "split": stock splits and reverse splits (share consolidations) - "ipo": upcoming IPO listings - "macrodata": macro economic data releases (CPI, NFP, rate decisions, etc.) - "closed": market closure days

End date in YYYY-MM-DD format (inclusive). Defaults to 7 days after start.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional market filter. One of: HK, US, CN, SG, JP, UK, DE, AU. Omit to include all markets.

Start date in YYYY-MM-DD format (inclusive). Defaults to today (UTC).

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Statement kind: "IS" (income statement), "BS" (balance sheet), "CF" (cash flow), "ALL" (default)

Report period: "af" (annual), "saf" (semi-annual), "q1"/"q2"/"q3" (quarterly), "qf" (quarterly full)

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Fiscal period, e.g. "1" "2" "3" "4"

Fiscal year, e.g. 2024

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Report type: "qf" (quarterly), "saf" (semi-annual), "af" (annual)

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Statement kind: "IS" (income statement), "BS" (balance sheet), "CF" (cash flow), "ALL" (default)

Report period: "af" (annual), "saf" (semi-annual), "qf" (quarterly full), "q1"/"q2"/"q3"

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

The confirmation_code from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Grid order ID.

History cursor for paging the embedded trigger history.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page size for the embedded sub-order / history lists.

Grid order ID.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Records per page (default 20).

Page number (default 1).

Sort field (e.g. "created_at").

Sort order ("asc" / "desc").

Comma-joined status filter, e.g. "Performing,Suspended". Omit for all.

Filter by symbol, e.g. "700.HK". Omit for all grid orders.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Grid order IDs to fetch, e.g. ["123", "456"].

The confirmation_code from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative.

Expiry time in unix seconds (use with GTD).

Buy-side order type when depth is 0: GMO / GLO / GTG.

Sell-side order type when depth is 0: GMO / GLO / GTG.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Action at lower bound: 1 = ignore (keep running), 2 = close at last price.

Lower price bound (decimal string).

Quantity handled when the lower bound is reached (decimal string).

Whether one grid level may trigger multiple times.

Grid order ID to replace.

Regular-trading-hours flag: 0 / 1 / 2.

Base price the grid is anchored to (decimal string).

Whether short selling is allowed.

Time in force: 0 = Day, 1 = GTC, 6 = GTD.

Buy-side order-book depth (-5..5; 0 = use grid_order_type_down).

Downward trigger percent (decimal string; use with type 2).

Upward trigger percent (decimal string; use with type 2).

Trigger price type: 1 = spread (absolute), 2 = percent.

Quantity per trigger (decimal string).

Sell-side order-book depth (-5..5; 0 = use grid_order_type_up).

Downward trigger spread, absolute (decimal string; use with type 1).

Upward trigger spread, absolute (decimal string; use with type 1).

Action at upper bound: 1 = ignore (keep running), 2 = close at last price.

Upper price bound (decimal string).

Quantity handled when the upper bound is reached (decimal string).

The confirmation_code from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Grid order ID.

The confirmation_code from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative.

Expiry time in unix seconds (use with GTD).

Buy-side order type when depth is 0: GMO / GLO / GTG.

Sell-side order type when depth is 0: GMO / GLO / GTG.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Action at lower bound: 1 = ignore (keep running), 2 = close at last price.

Lower price bound (decimal string).

Quantity handled when the lower bound is reached (decimal string).

Whether one grid level may trigger multiple times.

Regular-trading-hours flag: 0 / 1 / 2.

Settlement currency, e.g. "HKD".

Base price the grid is anchored to (decimal string).

Whether short selling is allowed.

Security symbol, e.g. "700.HK".

Time in force: 0 = Day, 1 = GTC, 6 = GTD.

Buy-side order-book depth (-5..5; 0 = use grid_order_type_down).

Downward trigger percent (decimal string; use with type 2).

Upward trigger percent (decimal string; use with type 2).

Trigger price type: 1 = spread (absolute), 2 = percent.

Quantity per trigger (decimal string).

Sell-side order-book depth (-5..5; 0 = use grid_order_type_up).

Downward trigger spread, absolute (decimal string; use with type 1).

Upward trigger spread, absolute (decimal string; use with type 1).

Action at upper bound: 1 = ignore (keep running), 2 = close at last price.

Upper price bound (decimal string).

Quantity handled when the upper bound is reached (decimal string).

The confirmation_code from this request's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed it. The code is single use, expires in 10 minutes, and applies only to this exact request — change any field and it stops working. A grid strategy keeps placing orders on its own once live, so never quote the code back on your own initiative.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Grid order ID.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK".

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Records per page (default 20).

Grid order ID whose trigger history to fetch.

Page number (default 1).

End date (yyyy-mm-dd), optional

Whether to forward-adjust for splits/dividends (default: false / no adjust)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Period: 1m, 5m, 15m, 30m, 60m, day, week, month, year (default: day)

Start date (yyyy-mm-dd), optional

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Trade sessions: "intraday" (regular hours only) or "all" (include pre-market and post-market; default "all")

Number of candlesticks (optional, max 1000; default 100)

Whether to query forward in time (true) or backward (false; default)

Whether to forward-adjust for splits/dividends (default: false / no adjust)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Period: 1m, 5m, 15m, 30m, 60m, day, week, month, year (default: day)

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Reference datetime (yyyy-mm-ddTHH:MM:SS), omit to start from latest

Trade sessions: "intraday" (regular hours only) or "all" (include pre-market and post-market; default "all")

End time (RFC3339)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start time (RFC3339)

Filter by symbol (optional)

US accounts only: page size (default 20). Ignored for AP accounts.

US accounts only: page number (default 1). Ignored for AP accounts (the region is inferred from the account — do not pass it).

End date (yyyy-mm-dd)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market code: HK, US, CN, SG

Start date (yyyy-mm-dd)

End time (RFC3339)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start time (RFC3339)

Filter by symbol (optional)

US accounts only: page size (default 20). Ignored for AP accounts.

US accounts only: page number (default 1). Ignored for AP accounts (the region is inferred from the account — do not pass it).

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Industry symbol from industry_rank, e.g. "IN00258.US". The BK counter_id form ("BK/US/IN00258") is also accepted.

Ranking indicator (default: "0"): "0" = 领涨行业, "1" = 今日走势, "2" = 行业人气, "3" = 市值, "4" = 营收, "5" = 营收增长率, "6" = 净利润, "7" = 净利润增长率

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of results to return (default: returns all)

Market: "US" | "HK" | "SG" | "CN"

Sort type: "0" = 单级 (default) | "1" = 多层

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number (default: 1)

Page size (default: 20)

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Trade sessions to include: "intraday" (default, regular hours only) or "all" (include pre-market and post-market).

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market: "HK" or "US" (default: inferred from symbol suffix)

Security symbol, e.g. "6871.HK" or "ARM.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number (default: 1)

Page size (default: 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

IPO order ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by market: "HK" or "US"

Page number (default: 1)

Page size (default: 20)

Filter by order status

Filter by symbol, e.g. "6871.HK"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number (default: 1)

Period filter: "all", "ytd", "1y", "3y" (default: "all")

Page size (default: 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Latest release date to include (YYYY-MM-DD, e.g. "2024-12-31").

Indicator code from macrodata_indicators, e.g. "30771718".

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Maximum number of data points to return (default 100, max 100).

Pagination offset for historical data points, default 0.

Earliest release date to include (YYYY-MM-DD, e.g. "2024-01-01").

Filter by country code. One of: "US", "CN", "HK", "EU", "JP", "SG". Omit to return all countries.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Keyword to search indicator names (e.g. "CPI", "非农", "GDP").

Maximum number of indicators to return (default 100, max 1000).

Pagination offset, default 0.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market code: HK, US, CN, SG

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

News article ID (numeric), e.g. "7123456789012345678". Get IDs from news or news_search.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Search keyword

Max results to return (default: 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Date (yyyy-mm-dd)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Option contract symbols, e.g. ["AAPL230317P160000.US"]. These are NOT plain stock symbols — get valid ones from option_chain_info_by_date's per-strike call.symbol/put.symbol fields (after listing expiry dates with option_chain_expiry_date_list).

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Underlying symbol (US market only), e.g. "AAPL.US"

Number of trading days to return (default 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Underlying symbol (US market only), e.g. "AAPL.US"

Set to true when order_id is the ID of an attached take-profit / stop-loss leg rather than a parent order. The response is then that leg itself, with charge_detail null. Omit (or false) for parent orders. Has no effect for US accounts, which are served by the US order endpoint.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Order ID to look up. A parent order ID, or (with is_attached=true) the ID of an attached take-profit / stop-loss leg.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

End date (yyyy-mm-dd). Must be paired with start; passing only one returns empty results.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start date (yyyy-mm-dd). Must be paired with end; passing only one returns empty results.

End date (yyyy-mm-dd). Must be paired with start; passing only one returns empty results.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start date (yyyy-mm-dd). Must be paired with end; passing only one returns empty results.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

End date (YYYY-MM-DD) for the K-line range

Script input values as a JSON array, e.g. "[14,2.0]". Must match the order of input.*() calls in the script.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

K-line period: 1m, 5m, 15m, 30m, 1h, day, week, month, year (default: day)

Indicator script source.

Start date (YYYY-MM-DD) for the K-line range

Symbol in <CODE>.<MARKET> format, e.g. TSLA.US, 700.HK

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["700.HK", "AAPL.US"]. Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Tab key from rank_categories second_tags[].key, e.g. "hot_all-us" (US total heat), "hot_up-hk" (HK rising heat), "trade_heat-us" (US hot trades). The "ib_" prefix is stripped from rank_categories keys and added back automatically.

Market override: "US" | "HK" | "CN" | "SG". Defaults to the market suffix in the key (e.g. "ib_hot_all-hk" → HK), then "US".

Whether to include related news articles (default: false)

Number of results to return (default: 20)

New order type for the triggered leg, e.g. "LO" or "MO".

Set to true to cancel every attached take-profit / stop-loss leg of this order, leaving the order itself in place.

New expiry for the attached leg as a unix timestamp in seconds. Required when attached_time_in_force is GTD.

ID of the parent order that owns the attached leg, when the leg is modified on its own rather than through its parent.

Reference market price for the attached leg.

Attached leg to add or update: "PROFIT_TAKER", "STOP_LOSS" or "BRACKET". Required unless the only attached change is attached_cancel_all.

New outside-RTH setting for the triggered leg: "RTH_ONLY" / "ANY_TIME" / "OVERNIGHT".

ID of the existing take-profit leg to update (from order_detail's attached_orders[]). Omit to add a new leg.

New take-profit trigger price.

New limit price for the take-profit leg.

New quantity for the attached leg.

ID of the existing stop-loss leg to update (from order_detail's attached_orders[]). Omit to add a new leg.

New stop-loss trigger price.

New limit price for the stop-loss leg.

New time-in-force for the attached leg: "Day" / "GTC" / "GTD".

The confirmation_code from this order's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed that exact order. The code is single use, expires in 10 minutes, and applies only to this exact order — change any field and it stops working. Never quote it back on your own initiative, and never in the same turn the user first asks.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

New limit offset from the trailing stop price (for TSLPAMT / TSLPPCT)

Order ID to replace (returned by submit_order or listed in today_orders / history_orders)

New limit price (for limit-style orders)

New order quantity (number of shares)

New trailing amount as absolute price distance (for TSLPAMT)

New trailing percent as decimal e.g. 0.05 = 5% (for TSLPPCT)

New trigger (activation) price (for LIT / MIT / trailing-stop orders)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional security symbol to filter indicators for a specific stock, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market filter: "US" | "HK" | "CN" | "SG" (default: "US")

Mode B — Filter conditions, passed directly to the API. Omit for Mode A. Fundamental keys (pass with or without filter_ prefix): pettm pbmrq roe roa netmargin salesgrowthyoy netincomegrowthyoy marketcap(亿) circulating_marketcap(亿) prevclose prevchg(%) divyld la epsttm netincome(亿) sales(亿) turnover_rate balance(万) Technical indicator keys (tech_values required; call screener_indicators for schema): macd_day/week → {"category":"goldenfork"|"deadcross","period":"day"|"week"} rsi_day/week → {"value_type":"overbought"|"oversold"} kdj_day/week → {"category":"goldenfork"|"deadcross"} boll_day/week → {"category":"breakthrough_up"|"breakthrough_down"}

Extra indicator keys to include in each result row (display-only, not used as filters). Same key naming as conditions (filter_ prefix added automatically). Example: ["marketcap", "prevclose", "epsttm"]

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market: "US" | "HK" | "CN" | "SG". Mode A: overridden by the market embedded in the strategy; pass any value or omit. Mode B: required — determines which market to screen.

Page number, 0-based (default: 0)

Page size (default: 20, max: 100)

Indicator key to sort results by (e.g. "marketcap", "roe"). Defaults to the first condition key. Must be one of the condition or extra_returns keys.

Sort order: "asc" | "desc" (default: "desc")

Mode A — Strategy ID from screener_recommend_strategies screeners[].id. The tool auto-fetches the strategy and builds filters. Omit for Mode B.

Strategy ID from screener_recommend_strategies or screener_user_strategies screeners[].id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market filter: "US" | "HK" | "CN" | "SG" (default: "US")

The optional start time of the fact query, formatted as 2006-01-02T15:04:05Z in UTC Timezone. If left empty, the query will include the earliest available data.

The end time of the fact to be queried, formatted as 2006-01-02T15:04:05Z in UTC Timezone. If left empty, the query will default to retrieving the latest data.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

The maximum number of facts to return. If the number of facts in the time range exceeds this limit, only the latest 'limit' facts will be returned. Defaults to 100.

Security symbol to query, e.g. "AAPL.US" or "700.HK".

Category filter. Currently only "Overnight" is supported; omitting defaults to Overnight.

Records per page (default: 50)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market code: US, HK, CN, SG

Page number, 1-based (default: 1)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Shareholder object_id from shareholder_top tool

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "AAPL.US"

Sharelist ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["AAPL.US", "700.HK"]

List description. Defaults to name when omitted.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

List name (also used as description if description is omitted).

Sharelist ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Sharelist ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of lists to return (default 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of lists to return (default 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Sharelist ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["AAPL.US", "700.HK"]

Sharelist ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["AAPL.US", "700.HK"]

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of records to return (1-100, default 20)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "AAPL.US" (US) or "700.HK" (HK). Market is inferred from suffix.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Query cutoff timestamp in seconds (pass current timestamp for latest data)

Page size: 1–100 (default: 20)

Security symbol, e.g. "AAPL.US" (US) or "700.HK" (HK). Market is inferred from suffix.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Signal ID, e.g. "sign_992_1a00c9425c3_48ab". Get IDs from signals.

Filter by the name of the factor that triggered the signal, e.g. "EARNINGS_RELEASED" or "macd_12_26_9" — not the display label returned in key_catalyst. If omitted, signals with any catalyst name are returned.

Filter by the catalyst type that triggered the signal, e.g. "News", "Fundamental", "Technical". If omitted, signals with any catalyst type are returned.

Filter records created at or before this time. ISO 8601 datetime with timezone. If omitted, no upper bound.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Maximum number of results to return. Defaults to 20.

Number of results to skip for pagination. Defaults to 0.

Filter records created at or after this time. ISO 8601 datetime with timezone, e.g. 2024-01-15T10:30:00Z. If omitted, no lower bound.

Filter by strategy id (e.g., "buffett-value"). Preferred over the deprecated strategy_name; takes precedence when both are provided.

Filter by strategy name. If omitted, returns signals from all strategies.

Filter by security symbol, e.g. "AAPL.US" or "700.HK". If omitted, returns signals for all symbols.

File key from statement_list, e.g. "/statement_data/data/.../20975338.json"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of records to return. Defaults to 30 for "daily" or 12 for "monthly". The default depends on statement_type, so the schema declares none: skip_serializing_if is what stops schemars deriving default: null from serde(default), which would contradict the integer type.

Start date (yyyy-mm-dd). Defaults to 30 days ago for "daily" or 12 months ago for "monthly".

Statement type: "daily" (default) or "monthly".

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["700.HK", "AAPL.US"]. Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

The legs of the combination, in strategy order. Option symbols only.

Order type: LO (Limit, requires submitted_price) or MO (Market)

Order remark (max 255 characters)

Buy or Sell — the direction of the strategy as a whole

Strategy, which fixes how many legs are required and the direction of each: CoveredCall / CoveredPut (stock + option) / VerticalCallSpread / VerticalPutSpread / Collar / Straddle / Strangle

Net limit price for the whole combination. Required for LO.

Number of strategy units to trade (each unit is one set of legs in the ratios given by legs)

Order type the attached leg is submitted as once triggered, e.g. "LO" (then set the matching attached_*_submit_price) or "MO".

Expiry of the attached leg as a unix timestamp in seconds (e.g. "1767139200"). Required when attached_time_in_force is GTD.

Attach a take-profit / stop-loss leg to this order: "PROFIT_TAKER" (take-profit only), "STOP_LOSS" (stop-loss only) or "BRACKET" (both). Omit for a plain order; every other attached_* field is ignored without it.

Outside-RTH setting of the triggered leg: "RTH_ONLY" / "ANY_TIME" / "OVERNIGHT".

Take-profit trigger price. Required for PROFIT_TAKER and BRACKET.

Limit price of the take-profit leg, for an LO attached_activate_order_type.

Stop-loss trigger price. Required for STOP_LOSS and BRACKET.

Limit price of the stop-loss leg, for an LO attached_activate_order_type.

Time-in-force of the attached leg: "Day" / "GTC" / "GTD". Defaults to the parent order's setting when omitted.

The confirmation_code from this order's dry run. WITHOUT IT NOTHING IS SENT. Omitted (the default) makes this a DRY RUN: the request is validated and echoed back with a three-digit confirmation_code, and nothing reaches the exchange. Required protocol: call once without execute, show the returned preview to the user, and call again quoting the code only after the user has explicitly confirmed that exact order. The code is single use, expires in 10 minutes, and applies only to this exact order — change any field and it stops working. Never quote it back on your own initiative, and never in the same turn the user first asks.

Expiry date (yyyy-mm-dd). Required when time_in_force is GTD

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Limit offset from the trailing stop price. Required for: TSLPAMT, TSLPPCT

Order type (HK supports all; US supports LO/MO/LIT/MIT/TSLPAMT/TSLPPCT only): - LO (Limit Order): requires submitted_price - ELO (Enhanced Limit Order, HK only): requires submitted_price - MO (Market Order): no price required - AO (At-auction Order, HK only): executed at auction price, no price required - ALO (At-auction Limit Order, HK only): requires submitted_price - ODD (Odd Lots Order, HK only): requires submitted_price, for non-standard lot sizes - LIT (Limit If Touched): requires submitted_price and trigger_price; activates when market price touches trigger_price - MIT (Market If Touched): requires trigger_price only; executes at market when trigger_price is touched - TSLPAMT (Trailing Limit If Touched by Amount): requires trailing_amount and limit_offset; trailing stop by fixed amount - TSLPPCT (Trailing Limit If Touched by Percent): requires trailing_percent (0-1) and limit_offset; trailing stop by percentage - SLO (Special Limit Order, HK only): requires submitted_price; cannot be replaced after submission

Outside regular trading hours: "RTH_ONLY" (regular trading hours only), "ANY_TIME" (any time including pre/post market), "OVERNIGHT" (overnight session, US only)

Order remark (max 255 characters)

Buy or Sell

Limit price. Required for: LO, ELO, ALO, ODD, LIT, SLO

Order quantity (number of shares)

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Order validity: "Day" (Day Order, expires end of session), "GTC" (Good Til Canceled), "GTD" (Good Til Date, requires expire_date)

Trailing amount (absolute price distance). Required for TSLPAMT

Trailing percent as decimal (e.g. 0.05 = 5%). Required for TSLPPCT

Trigger (activation) price. Required for: LIT, MIT, TSLPAMT, TSLPPCT

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by a specific order_id.

Filter by symbol, e.g. "700.HK".

Only meaningful together with order_id: it says that order_id is the ID of an attached take-profit / stop-loss leg, and the response then carries that leg itself as an order entry. On its own it does nothing, and it has no effect for US accounts either.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by order ID: a parent order ID, or (with is_attached=true) the ID of an attached take-profit / stop-loss leg. Has no effect for US accounts, which are served by the US order endpoint.

Filter by symbol, e.g. "700.HK". Omit to return all today's orders.

US accounts only: filter by side, "Buy" or "Sell". Omit for all. Ignored for AP accounts (the region is inferred from the account — do not pass it).

US accounts only: page size (default 20). Ignored for AP accounts.

US accounts only: page number (default 1). Ignored for AP accounts.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Topic body. "post" type is plain text only; "article" type accepts Markdown.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Related security symbols, e.g. ["700.HK", "TSLA.US"] (max 10).

Topic title. Required when topic_type is "article", optional for "post".

Topic type: "post" (default, plain text) or "article" (Markdown, title required).

Reply body (plain text only).

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional parent reply ID for nested replies. Get IDs from topic_replies. Omit for a top-level reply.

Topic ID to reply to.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Topic ID

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number, 1-based (default: 1).

Records per page, 1-50 (default: 20).

Topic ID.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Search keyword

Max results to return (default: 20)

Date to query in "YYYY-MM-DD" format. Omit for today's movers.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Number of events to return per page (default: 20, max: 100)

Market filter: comma-separated list of markets to include. Supported values: "HK", "US", "CN", "SG". Omit to return all markets. Example: "HK,US"

Pagination cursor from previous response next_params field. Pass the entire next_params object returned by the previous call to get the next page. Omit for the first page.

Sort order (default: "2"): "0" = by time (most recent first) "1" = by price change magnitude (largest move first) "2" = by popularity (most-viewed first)

Maximum number of results (max 1000)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

End date (yyyy-mm-dd)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Market code: HK, US, CN, SG

Start date (yyyy-mm-dd)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Watchlist group id

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Update mode for securities: "add", "remove", or "replace" (default: "replace")

New group name (optional)

Securities list (optional)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Comparison symbols, comma-separated, max 4, e.g. "MSFT.US,GOOGL.US". Note: pending backend support — currently server auto-selects industry peers.

Currency: "USD" | "HKD" | "CNY"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol to compare, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbol, e.g. "700.HK". Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

End date in yyyymmdd format (default: today)

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Start date in yyyymmdd format (default: 30 days ago)

Security symbol, e.g. "AAPL.US"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by expiry date range (optional): "LT_3" (<3 months), "Between_3_6" (3-6 months), "Between_6_12" (6-12 months), "GT_12" (>12 months)

Filter by issuer ID (optional), use issuer_id from warrant_issuers tool

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Filter by in/out of bounds (optional): "In" (in bounds), "Out" (out of bounds). Only for Inline warrants.

Sort field: LastDone, ChangeRate, ChangeValue, Volume, Turnover, ExpiryDate, StrikePrice, UpperStrikePrice, LowerStrikePrice, OutstandingQuantity, OutstandingRatio, Premium, ItmOtm, ImpliedVolatility, Delta

Sort order: Ascending or Descending

Filter by status (optional): "Suspend" (suspended), "PrepareList" (pending listing), "Normal" (normal trading)

Underlying symbol, e.g. "700.HK"

Filter by warrant type (optional): "Call", "Put", "Bull", "Bear", "Inline"

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Security symbols, e.g. ["700.HK", "AAPL.US"]. Use the canonical form — a padded code like "00700.HK" returns an empty record, not an error.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the env/debug/stderr builtins are unavailable. Example: .data | map({symbol}). Omit for the full response.

Page number (default: 1)

Page size (default: 20)