tossctl
Reference

Support Scope

Coverage vs the official Open API

tossctl covers 100% of the official Toss Open API's read & trade scope — and goes beyond. Register an official key and the features it supports are actually routed through OAuth; the rest go through WTS. See the Hybrid guide for setup.

  • ✅ supported · ❌ not supported · 🔸 partial
  • Official API column = coverage per public docs; with an official key, ✅ rows are routed via OAuth
  • Rows where official is ❌ = tossctl-only (always via WTS)

openapi commands

CommandDescription
tossctl initOnboarding wizard — step-by-step session, official key, and trading setup
tossctl openapi loginRegister your key (env vars TOSSCTL_OPENAPI_KEY/TOSSCTL_OPENAPI_SECRET or flags)
tossctl openapi statusDiagnose key · token · allowed IPs · routing state
tossctl openapi testValidate connectivity with a real API call
tossctl openapi logoutDelete the credentials file

Use the global --backend auto|wts|openapi flag to override routing per request.

Read-only

FeatureCommandOfficial APItossctl
Accounts / summaryaccount list, account summary
Portfolioportfolio positions, portfolio allocation
Trade ticks / orderbookquote trades, quote orderbook
Price limits / buy cautionsquote limits, quote warnings
Sellable qty / commissionquote sellable, quote commission
Quote / candlesquote get, quote chart🔸
Multi-quote / live refreshquote batch --live
Investor flowsquote flows
Market indices / index detailmarket index [<code|name>]
Live popularity rankingmarket ranking
Net-buy by investormarket investors
Sector movementsmarket sectors
Earnings calendarmarket earnings [--major]
Personalized news briefingmarket briefing
Toss AI signalsmarket signals
Screenermarket screener
Dividend reportportfolio dividends
Community rankingscommunity rankings
Watchlist read & managementwatchlist ...
Transaction ledger / cash overviewtransactions list/overview
CSV exportexport ...

Trading

FeatureCommandOfficial APItossctl
Buy/sell ordersorder place
Cancel / amendorder cancel, order amend
dry-run previeworder preview
Fractional orders (US, amount/qty)order place --fractional
Fractional orders — KRW settlementorder place --fractional --currency-mode KRW
Real-time push (SSE)push listen

Fractional sell (beta)

Implements the US market fractional-quantity SELL added in official Open API 1.1.5 (order place --fractional --side sell --qty 0.5, up to 6 decimals). Contract-tested, but not yet live-verified — run order preview before any live trade. Fractional buy remains amount-based (--amount).

Verification basis

The Official API column is verified against a specific version of the official Open API docs. The verified version and last-checked date are recorded in .openapi-snapshot.json; the full spec is mirrored daily and changes are auto-detected.

The full WTS web API catalog (implemented / next candidate / intentionally excluded) is continuously tracked in wts-endpoints.json.

On this page