Documentation
Guides and tools for the tastytrade Open API. For endpoint-level details see the API Reference, and for agents the /llms.txt index.
Base URLs
- Production
https://api.tastyworks.com- Sandbox
https://api.cert.tastyworks.com
Sandbox and production credentials are separate. Try a flow in sandbox first, and always send a User-Agent header in the form <product>/<version> (e.g. my-app/1.0). Requests without one are rejected with a 401.
Get started
- QuickstartZero to your first call: credentials, a 15-minute token, list accounts, and a safe sandbox order.
- Agent QuickstartEnd-to-end agent walkthrough: discover, auth, quote, dry-run, order, confirm — safely.
- AI prompt for a personal appA copyable prompt for an AI coding assistant to build a small read-only personal app: OAuth2 refresh tokens, accounts, balances, positions and transaction history.
- SandboxBase URLs, how simulated fills are decided, what the sandbox cannot do, and how to get an account.
- Release NotesNotable API changes, newest first, such as decommissioned endpoints, pagination changes and cryptocurrency availability.
Authentication
Concepts
- Accounts & CustomersThe customer to accounts model, authority levels, and the me shortcut.
- Instruments & SymbologyEquities, options (OCC), futures, future options, and crypto symbology.
- Dates & TimesDate and timestamp formats, date versus date-time query parameters, and parsing offsets.
- Orders & Order TypesOrder/leg structure, order types, time-in-force, and complex orders (OTO/OCO/OTOCO).
- Order LifecycleOrder status from submission through working to terminal, and partial fills.
- Positions & BalancesBalances (cash, net-liq, buying power) and positions (quantity, mark, cost basis).
- Market DataREST market data by instrument type, fields, and the 100-symbol batch limit.
- StreamingDXLink market-data streaming and the account-update WebSocket.
- Margin & RiskMargin requirements, the margin dry-run, trading status, and risk parameters.
- API VersionsDate-based versions, the Accept-Version header, 6-month deprecation windows, and the 406 for a retired version.
Guides
- Idempotency & retriesSafe retries with a unique external-identifier + status checks (no idempotency-key header; the API does not deduplicate).
- Rate limits & backoff429 thresholds, failed-login IP block, exponential backoff, streaming/batching to reduce load.
- Place an equity orderStep-by-step: dry-run then submit a single-leg equity order, safely.
- Multi-leg spreadsBuild verticals, iron condors, and strangles as multi-leg option orders.
- Error handlingRead the error envelope, branch on the code, and recover via the doc_url anchor convention.
- Stream market dataConnect to the DXLink market-data WebSocket: token, SETUP/AUTH, channel, subscribe, read feed.
- Stream account updatesSubscribe to the account WebSocket for live order, position, and balance notifications.
- Run a backtestSubmit a backtest, poll for completion, and read the results.
- Manage watchlistsCreate, read, update, and delete watchlists and their entries.
- Pagination & filteringPage through large collections and filter/sort list endpoints.