/install ibkr
IBKR Skill
Overview
This skill integrates with Interactive Brokers Trader Workstation (TWS) and IB Gateway through ib_insync, exposing operational IBKR workflows through:
- A unified Python CLI:
scripts/ibkr_cli.py - A bash CLI wrapper:
scripts/ibkr.sh - Compatibility alias:
scripts/openclaw.sh - Backward-compatible script entrypoints:
scripts/get_account_info.pyscripts/get_historical_data.pyscripts/place_order.py
Prerequisites
- Interactive Brokers account with API permissions.
- TWS or IB Gateway running with API enabled.
- Python 3.9+ recommended.
ib_insyncinstalled:
pip install ib_insync
Connection Configuration
All CLIs support connection overrides using flags or env vars.
Environment variables:
IBKR_HOST(default127.0.0.1)IBKR_PORT(default7497)IBKR_CLIENT_ID(default1)IBKR_ACCOUNT(optional)
Examples:
IBKR_PORT=4002 IBKR_CLIENT_ID=14 ./scripts/ibkr.sh account-summary
python3 scripts/ibkr_cli.py positions --host 127.0.0.1 --port 7496 --account DU123456
Bash CLI
./scripts/ibkr.sh \x3Ccommand> [args]
Supported commands:
account(account summary + positions)account-summarypositionsportfoliopnlquotehistoricalplace-ordercancel-orderopen-ordersexecutionscontract-detailsscanner
./scripts/openclaw.sh is an alias to the same CLI surface.
Python CLI
python3 scripts/ibkr_cli.py \x3Ccommand> [args]
Account Services
python3 scripts/ibkr_cli.py account-summary --json
python3 scripts/ibkr_cli.py positions --account DU123456
python3 scripts/ibkr_cli.py portfolio --json
python3 scripts/ibkr_cli.py pnl --account DU123456 --wait 2
Market Data Services
python3 scripts/ibkr_cli.py quote --symbol AAPL --sec-type STK --market-data-type 3
python3 scripts/ibkr_cli.py historical --symbol EURUSD --sec-type CASH --duration "30 D" --bar-size "1 hour"
Notes:
- Historical requests support full IB-format values via flags, including spaced tokens like
"30 D". - For
CASH, defaultwhatToShowisMIDPOINTunless explicitly overridden.
Contract Discovery
python3 scripts/ibkr_cli.py contract-details --symbol ES --sec-type FUT --expiry 202606
Trading and Order Lifecycle
python3 scripts/ibkr_cli.py place-order --symbol AAPL --sec-type STK --action BUY --quantity 10 --order-type MKT
python3 scripts/ibkr_cli.py place-order --symbol AAPL --sec-type STK --action SELL --quantity 10 --order-type LMT --limit-price 250 --tif GTC
python3 scripts/ibkr_cli.py open-orders
python3 scripts/ibkr_cli.py cancel-order --order-id 12345
python3 scripts/ibkr_cli.py executions --json
Supported order types in the CLI:
MKTLMTSTPSTP LMT
place-order waits for status updates and surfaces API errors collected during placement.
Scanner Service
python3 scripts/ibkr_cli.py scanner --instrument STK --location-code STK.US.MAJOR --scan-code TOP_PERC_GAIN --rows 25
Compatibility Scripts
Legacy scripts remain supported and now delegate to the unified CLI:
get_account_info.pyget_historical_data.py(legacy positional mode still works)place_order.py(legacy positional mode still works)
Error Handling
The CLI returns non-zero exit codes for:
- Import/dependency failures
- Connection failures
- Contract qualification failures
- Invalid arguments
- Missing open order for cancellation
References
See references/api_reference.md for IBKR and ib_insync documentation links.
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install ibkr - 安装完成后,直接呼叫该 Skill 的名称或使用
/ibkr触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
IBKR CLI 是什么?
Comprehensive Interactive Brokers (IBKR) TWS/Gateway skill using ib_insync. Includes Python and bash CLIs for account, market data, historical data, contract... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 645 次。
如何安装 IBKR CLI?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install ibkr」即可一键安装,无需额外配置。
IBKR CLI 是免费的吗?
是的,IBKR CLI 完全免费(开源免费),可自由下载、安装和使用。
IBKR CLI 支持哪些平台?
IBKR CLI 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 IBKR CLI?
由 oscraters(@oscraters)开发并维护,当前版本 v1.0.0。