Cash-sweep configuration and redemption capacity¶
Both read-only APIs require acc:read, extension_version: 1, and --enable-desktop-phase2-reads. The flag defaults to OFF; live backend behavior is UNVERIFIED. Reads do not activate, pause, subscribe to, or redeem a fund.
| API / CLI | REST POST |
|---|---|
GetCashSweepConfiguration / get-cash-sweep-configuration |
/api/trd/cash-sweep-configuration |
GetCashSweepRedemptionCapacity / get-cash-sweep-redemption-capacity |
/api/trd/cash-sweep-redemption-capacity |
Configuration takes a nonzero raw broker_id. Confirmed session facts select the personal or institutional backend. This aggregate read rejects any API key with allowed_acc_ids configured, including an empty list, before backend requests.
is_company selects exactly one of personal and institutional. Each retains optional status, activation state, notice ID and the full configuration list. Institutional rows include owner information only within the authorized aggregate result. Account, subscription, redemption and fund fields retain their original optional values, strings and numeric states. Missing activation does not mean an explicit false.
Capacity takes a real business-account header (trd_env: 1, acc_id, trd_market). Select the actual securities business child with fund capability for a universal account, not its aggregate parent ID. Trading unlock is not required; account restrictions remain enforced.
Results retain err_code, status, supported_ccy, and currency rows containing ccy, amount, redeemable_amount, pending_redeem_amount. Amount already includes pending redemption; do not add it twice or add these values to existing total assets.
Asset changes invalidate the corresponding internal last-good capacity snapshot. Explicit queries fetch current backend data. Stale snapshots and failed requests are never returned as a current success or zero balance.
MCP tools are futu_get_cash_sweep_configuration and futu_get_cash_sweep_redemption_capacity, with c2s_json and optional api_key. All five API surfaces share the same contract.