tossctl
Reference

Command Reference

Key CLI commands and complete surface discovery

This is a curated command reference. Use tossctl --help and subcommand help for all CLI options; use tossctl ops list and tossctl ops describe <id> for the ops/MCP catalog. General reads support --output table|json|csv; charts and streams have command-specific output formats.

Local history

CommandDescription
tossctl history sync [--from DATE --to DATE --market all]Preview SQLite collection; repeat with --execute --confirm <token> to save
tossctl history listCollection IDs, freshness, coverage, and completeness
tossctl history positions [--snapshot ID]Read stored holdings
tossctl history transactions [--snapshot ID] [--query TEXT]Filter, search, and page through stored transactions
tossctl history search <query> [--snapshot ID]Literal transaction search
tossctl history compare <before-id> <after-id>Compare quantity and valuation changes

All commands except sync work offline. See the collection contract.

Auth

CommandDescription
tossctl auth login [--link] [--headless] [--qr-output <path>]QR or tap-on-phone link + phone-approval login
tossctl auth statusSession validity / expiry
tossctl auth extend [--timeout 120s] [--if-expiring 48h]Extend via phone push (~7 days), optionally skip while enough time remains

Account & Portfolio

CommandDescription
tossctl account listAccounts
tossctl account buying-powerOfficial buying power (official key required)
tossctl account summaryTotal assets, P&L, by market
tossctl portfolio positionsHoldings (USD shown for US)
tossctl portfolio briefing [--news-limit N]Combine holdings, news, upcoming earnings calls, and pending orders
tossctl portfolio allocationAllocation
tossctl portfolio folders [--account <key>]User-defined folder holdings and fee-adjusted P/L (account and internal folder keys omitted)
tossctl portfolio performance [--account <key>]One-month daily principal, valuation, return, and range high/low (all Securities accounts by default)
tossctl portfolio snapshots [--account <key>] [--cursor <key>] [--limit N]Cursor-paged dated portfolio valuation history
tossctl portfolio snapshot <YYYY-MM-DD> [--account <key>]Full market and holding detail for one valuation date
tossctl portfolio dividends [--year N] [--by-payment-date]Annual dividends (total, region, monthly, tax)
tossctl portfolio hidden list [--account <key>]Holdings hidden from the Securities portfolio (account key omitted)
tossctl portfolio hidden hide|show <symbol> [--execute --confirm <token>]Preview/confirm hiding or restoring a holding
tossctl profitCumulative realized profit (trading, dividends, lending, maturity, interest — KRW/USD)
tossctl tax overseas [--year N]Overseas transfer income (rate, deduction, per-stock P/L — for tax filing)
tossctl accumulate listStock accumulation plans — 📱 found in the Securities mobile UI, then WTS-call verified
tossctl accumulate status <symbol>Accumulation plan for one stock (Active/Paused)

Quotes

CommandDescription
tossctl quote get <symbol>Quote (OHLC, 52w, market cap, trading value, strength)
tossctl quote flows <symbol>Investor net-buy flows (WTS)
tossctl quote metadata <symbol>Official stock metadata (official key required)
tossctl quote batch <s1,s2,...> [--chart] [--live]Multi-quote / live refresh
tossctl quote chart <symbol> --interval 1m|...|60mASCII candle chart
tossctl quote orderbook <symbol>10-level orderbook
tossctl quote trades <symbol> --count NTrade ticks
tossctl quote limits <symbol>Price limits (KR)
tossctl quote warnings <symbol>Buy cautions
tossctl quote sellable <symbol>Sellable quantity
tossctl quote commission <symbol>Commission & tax rate
tossctl quote alert list <symbol>Securities target-price alerts
tossctl quote alert add|remove <symbol> --price N --currency KRW|USD [--execute --confirm <token>]Preview/confirm target-price alert changes

Market

CommandDescription
tossctl market index [<code|name>]Major indices / detail (OHLC, 52w, feed, session start/end/open state) with an argument
tossctl market news [--limit N]Market news
tossctl market business-days <KR|US> · tossctl market stocks <MARKET>Official business days and stock directory (official key required)
tossctl market ranking --size NLive popularity ranking
tossctl market investorsTop net-buy by investor (foreign, institution, retail)
tossctl market sectors [<id>]Sector movements (top-level/sub, 1d·1m·1y)
tossctl market sector <id>Current sector move, related-sector tree, constituents, ETFs, and news
tossctl market earnings [event-id]Earnings calendar / report and media links for an ID (--major: major companies)
tossctl market earnings transcript <event-id>Timestamped original paragraphs, nullable translations and summaries
tossctl market earnings report <event-id>Analysis, watch points and source IDs; unavailable sections remain null
tossctl market briefingPersonalized AI briefing with holdings/watchlist context, return, reasoning, news, and related stocks
tossctl market key-eventsCurrent key earnings and economic releases (estimates, actuals, previous values)
tossctl market signalsToss AI signals
tossctl market signal <symbol> [--type stocks|equity_etf|index]AI reasoning and source news for a stock, ETF, or index (e.g. KGG01P)
tossctl market fxFX & dollar index
tossctl market hoursTrading hours
tossctl market screener [<preset-id>] [--filter '<json>'] [--nation kr|us]Screener

market business-days KR returns combined KRX/NXT session times. An after-market session may exist while NXT is closed and its auction end is absent. See session and response scope.

earnings transcript returns available: false with an empty paragraph list when no transcript is available. Report analysis and watch points are independently nullable. Translation/summary nulls do not identify why content is unavailable. JSON preserves source IDs and timestamps; MCP may trim long results, so use fields projection or the CLI for the full transcript. market signal --type index uses index codes from market index; unavailable agreement metadata remains terms: null.

Community

CommandDescription
tossctl community rankings --type influencer|profit|followersCommunity rankings

Orders & Trading

Trading is disabled by default. See the Safety Model.

CommandDescription
tossctl order preview --symbol <s> --side <buy|sell> --qty <n> --price <p>dry-run preview (no order sent)
tossctl order place ... --execute --confirm <token>Live order (two-step gate)
tossctl order cancel --order-id <id> --symbol <s> [--execute --confirm <token>]Preview by default; cancel with that command's token
tossctl order amend --order-id <id> ... [--execute --confirm <token>]Preview by default; amend with that command's token
tossctl orders list · orders completed · order show <id>Pending/filled/single lookup
tossctl orders completed --all-dates --market all --size 50 --page 1Recent completed and canceled orders across all dates

orders completed defaults to the current month. --all-dates removes the date filter; --size (default 50) and --page (default 1) each accept 1–100. Only the requested page is returned. Reaching page N requires up to N history reads to follow server cursors. For MCP, pass {"all_dates":true,"market":"all","size":50,"page":1} to completed_orders. all_dates cannot be combined with from or to.

Fractional buys use --fractional --type market --amount <krw>; sells use --fractional --type market --side sell --qty <quantity>. Supply the other order fields and pass preview/execution gates. Fractional sells are not live-verified.

Conditional orders use order conditional list/get/place/cancel/modify and require an official key. Regular CLI orders choose an official/WTS route; ops/MCP live orders are official-only.

Transactions & Export

CommandDescription
tossctl transactions list --market us|krTrades, deposits/withdrawals, dividends ledger
tossctl transactions overview --market us|krOrderable / withdrawable / scheduled deposits
tossctl export positions|orders --market us|kr|allCSV export

Account extras & notifications

CommandDescription
tossctl account overview [--full]All-account and minor-account assets (account numbers masked by default)
tossctl account trading-settings [--account <key>]Read-only account-specific simple trade plus user-wide KRX/NXT, ATS notification, and option tick settings
tossctl account transfer-accounts [--account <key>] [--full]Securities own/recent transfer accounts (masked by default; never initiates a transfer)
tossctl account access-status [--account <key>]Last Securities login context and account-specific margin-freeze/accident-account status (read-only; raw account key omitted)
tossctl accumulate funding-status [--full]Securities accumulation funding and automated-order registration (banking status is a deprecated alias; not general Banking/MyData; holder/account masked, internal ID never emitted)
tossctl notifications listRead-only WTS notification preferences (internal user ID omitted)
tossctl notifications statusRead-only canonical preferences, inbox unread state, and AI-analysis agreement

Watchlist

CommandDescription
tossctl watchlist list [<group-id>] [--all] · watchlist groupsWatchlist items by folder / folder list
tossctl watchlist news <folder-id>Recommended news for one existing folder; server-limited first page
tossctl watchlist group create|rename|delete [--execute --confirm <token>]Preview/confirm folder changes; delete also needs --acknowledge-irreversible
tossctl watchlist add|remove <symbol or name> --group <id> [--execute --confirm <token>]Preview/confirm adding or removing symbols

Official Open API · Auto-routing

Connect an official key and supported reads/trades route through OAuth (tokens auto-refresh); other features use WTS. WTS features work with only a web session, while account buying-power, market business-days|stocks, quote metadata, conditional orders, and stream require the official key. See the auto-routing guide.

CommandDescription
tossctl initOnboarding wizard (web-session login, official key, trading config)
tossctl openapi loginRegister official API Key/Secret (env, flags, or interactive; file 0600)
tossctl openapi statusDiagnose key / token / allowed IPs / routing
tossctl openapi testVerify the connection with a real call
tossctl openapi ip listList currently allowed IP addresses (WTS session required)
tossctl openapi ip replace-currentPreview replacement with the current public IP; apply with --execute --confirm <token>
tossctl openapi logoutDelete the credential file
tossctl <command> --backend auto|wts|openapiPick the routing backend per request (global, default auto)

Experimental paper trading

Visible only after opting into experimental.paper_trading. Check server availability and known limits first.

CommandDescription
tossctl paper statusSimulated cash and prerequisite status
tossctl paper init · paper deposit <amount>Preview initialization or simulated funding
tossctl paper order place <option-code> · paper order cancel <order-id>Preview simulated placement or cancellation
tossctl paper orders pending · paper orders completedSimulated order history
tossctl paper orders cancel-allPreview bulk cancellation of simulated orders
tossctl paper order live-preview <option-code>Convert intent to a live preview without submission

Paper writes require explicit approval in the current request and --execute; they never authorize live trades.

Ops (push · monitor · doctor)

CommandDescription
tossctl stream --trade <symbol>Official WebSocket trade subscription (official key required; not exposed as MCP streaming)
tossctl update --checkRead-only update check
tossctl push listenReal-time push stream (orders/fills/holdings) via SSE
tossctl monitor api82 read probes by default, four more after paper opt-in; exit 0 on success, 1 on failure
tossctl doctor [--report]Env/session diagnostics + official key/token/IP checks (JSON, home paths masked)
tossctl versionVersion / update availability

On this page