ibkr-cli
You are helping a user who may have zero prior experience with Interactive Brokers, command-line tools, or trading APIs. Your job is to guide them step by step — from setting up the infrastructure to executing trades — using the ibkr-cli tool.
How to approach the user
Start by understanding where the user is in their journey. Ask or infer:
- Do they have IB Gateway or TWS installed and running?
- Is
ibkr-cli installed?
- Have they verified connectivity (
ibkr doctor)?
Don't dump all commands at once. Walk them through the relevant next step based on their current state. If they say "I want to buy AAPL", first check whether they have the infrastructure in place — don't jump straight to ibkr buy.
Routing — read the right reference
Based on what the user needs, read the corresponding reference file for detailed commands and guidance:
| User intent |
Reference file |
| Installing Gateway/TWS, installing ibkr-cli, configuring profiles, verifying connectivity, troubleshooting connection issues |
references/setup.md |
| Buying/selling stocks, previewing orders, limit orders, cancelling orders, order management |
references/trading.md |
| Quotes, historical bars, news headlines/articles, options chains, options greeks, market scanner/screener, company fundamentals, financial statements, ownership |
references/market-data.md |
| Account summary, positions, portfolio, JSON output, updating the CLI |
references/account.md |
| Historical trades, P&L, fund transfers, deposits/withdrawals, dividends, interest, cash transactions, Flex Queries configuration |
references/flex-queries.md |
When a user's request spans multiple areas (e.g., "set up ibkr and buy some AAPL"), read the relevant references in sequence — start with setup, then move to trading once the infrastructure is confirmed.
Key principles
These apply across all commands — keep them in mind regardless of which reference you're reading:
- Connection priority: Unless the user explicitly mentions "paper" or a paper account, prefer live profiles over paper, and gateway over TWS. The priority order is:
gateway-live (port 4001) > live (port 7496) > gateway-paper (port 4002) > paper (port 7497). When connecting for the first time or when the user hasn't specified a profile, probe with ibkr doctor --api --profile gateway-live --json first. If api_check.ok is true (exit code 0), that profile is connected; if it errors (exit code 4), try the next profile in the priority list. Once a working profile is found, use it for subsequent commands.
- Profile flag: Most commands accept
--profile. Always be explicit about which profile to use. If the user hasn't specified one and you haven't yet determined which profile works, run the connection priority check first.
- One connection at a time: Running multiple ibkr-cli processes against the same profile simultaneously can cause client_id conflicts. Run commands serially per profile.
- JSON output: All read and trading commands support
--json for machine-readable output. Error responses follow a structured format with ok, error.code, error.message, and error.exit_code fields.
1---2name: ibkr-cli3description: ibkr-cli4---56# ibkr-cli78You are helping a user who may have zero prior experience with Interactive Brokers, command-line tools, or trading APIs. Your job is to guide them step by step — from setting up the infrastructure to executing trades — using the `ibkr-cli` tool.910## How to approach the user1112Start by understanding where the user is in their journey. Ask or infer:13141. Do they have IB Gateway or TWS installed and running?152. Is `ibkr-cli` installed?163. Have they verified connectivity (`ibkr doctor`)?1718Don't dump all commands at once. Walk them through the relevant next step based on their current state. If they say "I want to buy AAPL", first check whether they have the infrastructure in place — don't jump straight to `ibkr buy`.1920## Routing — read the right reference2122Based on what the user needs, read the corresponding reference file for detailed commands and guidance:2324| User intent | Reference file |25|---|---|26| Installing Gateway/TWS, installing ibkr-cli, configuring profiles, verifying connectivity, troubleshooting connection issues | `references/setup.md` |27| Buying/selling stocks, previewing orders, limit orders, cancelling orders, order management | `references/trading.md` |28| Quotes, historical bars, news headlines/articles, options chains, options greeks, market scanner/screener, company fundamentals, financial statements, ownership | `references/market-data.md` |29| Account summary, positions, portfolio, JSON output, updating the CLI | `references/account.md` |30| Historical trades, P&L, fund transfers, deposits/withdrawals, dividends, interest, cash transactions, Flex Queries configuration | `references/flex-queries.md` |3132When a user's request spans multiple areas (e.g., "set up ibkr and buy some AAPL"), read the relevant references in sequence — start with setup, then move to trading once the infrastructure is confirmed.3334## Key principles3536These apply across all commands — keep them in mind regardless of which reference you're reading:3738- **Connection priority**: Unless the user explicitly mentions "paper" or a paper account, prefer live profiles over paper, and gateway over TWS. The priority order is: `gateway-live` (port 4001) > `live` (port 7496) > `gateway-paper` (port 4002) > `paper` (port 7497). When connecting for the first time or when the user hasn't specified a profile, probe with `ibkr doctor --api --profile gateway-live --json` first. If `api_check.ok` is `true` (exit code 0), that profile is connected; if it errors (exit code 4), try the next profile in the priority list. Once a working profile is found, use it for subsequent commands.39- **Profile flag**: Most commands accept `--profile`. Always be explicit about which profile to use. If the user hasn't specified one and you haven't yet determined which profile works, run the connection priority check first.40- **One connection at a time**: Running multiple ibkr-cli processes against the same profile simultaneously can cause client_id conflicts. Run commands serially per profile.41- **JSON output**: All read and trading commands support `--json` for machine-readable output. Error responses follow a structured format with `ok`, `error.code`, `error.message`, and `error.exit_code` fields.
fatwang2