Web API
All tools over the web
Every tool, grouped by area. Send a POST to the address shown, with your key in the header (see how to call any tool).
Stocks
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/visualize_price_overview | Free | Daily / weekly / monthly snapshot in one image. |
POST /api/v1/tools/get_price_data | Free | Historical OHLCV bars. |
POST /api/v1/tools/visualize_price_chart | Free | Candlestick price chart with overlays. |
POST /api/v1/tools/get_stock_quote | Free | Latest quote for a symbol. |
Options
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_option_expirations | Premium | Available expirations for a symbol. |
POST /api/v1/tools/get_options_chain | Premium | Full options chain for an expiration. |
POST /api/v1/tools/get_single_option_quote | Premium | Bid/ask/IV/greeks for one contract. |
POST /api/v1/tools/get_historical_contract_greeks | Premium | Day-by-day price history and greeks for ONE option contract, bid/ask/mid, the underlying's price, days to expiry, IV, delta, gamma, theta, vanna. Up to 90 trading days per call. |
Greek Exposure
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/analyze_greek_exposures | Premium | Net Gamma / Delta / Vanna / Theta exposure DATA grid across MULTIPLE expirations for one symbol, OI-weighted per-strike numbers (no chart). Sibling of Greek-Exposure-Single-Expiration (same data, one date) and Greek-Exposure-Heatmap (same numbers rendered as PNG). |
POST /api/v1/tools/greek_exposure_single_expiration | Premium | Greek exposures for ONE expiration date only, guaranteed single-chain fetch. Use when the caller knows the date (0DTE, weekly, monthly OPEX, dated event). |
POST /api/v1/tools/greek_exposure_heatmap | Premium | Heatmaps for one or more greeks in a single call. Pass greeks=["gamma","delta","vanna","theta"] (any subset). Returns one PNG per requested greek. |
POST /api/v1/tools/net_exposure_charts | Premium | Net exposure bar charts for one or more greeks. metrics=["net_gex","net_dex","net_vex","net_tex"]. Returns one PNG per metric. |
Options Flow
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_volume_oi_data | Premium | Top contracts by volume / OI as data. |
POST /api/v1/tools/volume_and_oi_charts | Premium | Top-volume and/or open-interest charts. types=["vol","oi","vol_oi"]. Returns one PNG per requested type. |
POST /api/v1/tools/get_options_flow | Premium | Stored option-trade tape filtered by side / type / premium / size / time window. Omit symbol for the top-N cross-universe ranking. |
POST /api/v1/tools/get_options_flow_contract | Premium | Per-hour premium histogram for ONE contract (open / close stack). Reads strictly from the flow archive cache, never pulls fresh chain. |
Charts
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/Vision_Analysis | Premium | AI vision analysis of a chart image. |
POST /api/v1/tools/visualize_multi | Free / Premium | Multi-timeframe charts side-by-side. |
Fundamentals
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_balance_sheet | Free | Latest balance sheet. |
POST /api/v1/tools/get_basic_financials | Free | Headline valuation + profitability metrics. |
POST /api/v1/tools/get_income_statement | Free | Latest income statement. |
Estimates
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_analyst_price_targets | Free | Consensus price targets. |
POST /api/v1/tools/get_earnings_estimates | Free | Consensus EPS estimates. |
POST /api/v1/tools/get_eps_trend | Free | EPS estimate trend. |
POST /api/v1/tools/get_growth_estimates | Free | Growth estimates summary. |
POST /api/v1/tools/get_revenue_estimates | Free | Consensus revenue estimates. |
Calendar
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_earnings_calendar | Free | Upcoming earnings releases. |
POST /api/v1/tools/get_earnings_dates | Free | Earnings dates for a symbol. |
POST /api/v1/tools/get_ipo_calendar | Free | Upcoming IPOs. |
Ownership
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_insider_transactions | Free | Recent insider buys / sells. |
POST /api/v1/tools/get_institutional_holders | Free | Top institutional holders. |
POST /api/v1/tools/get_sec_filings | Free | Recent SEC filings. |
POST /api/v1/tools/get_senate_lobbying | Free | Congressional trading / lobbying activity. |
Brokerage
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_account_balances | Free | Cash, buying power, equity for an account. |
POST /api/v1/tools/get_holdings | Premium | Positions in one linked account. |
POST /api/v1/tools/get_account_symbol | Premium | Resolve a ticker inside a linked account. |
POST /api/v1/tools/get_all_holdings | Premium | Positions across every linked account. |
POST /api/v1/tools/list_broker_connections | Premium | List linked brokerage accounts. |
POST /api/v1/tools/get_transactions | Premium | Transaction history with optional date range. |
Trading: Orders
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/delete_preview_order | Free | Discard a staged preview. |
POST /api/v1/tools/list_preview_orders | Free | List staged previews not yet placed. |
POST /api/v1/tools/place_order | Premium | Submit a previously previewed order. |
POST /api/v1/tools/preview_multiple_orders | Free | Stage several orders at once. |
POST /api/v1/tools/preview_order | Free | Stage an order for review without sending it to the broker. |
Trading: Triggers
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/create_trading_trigger | Premium | Create a price / condition-based trigger. |
POST /api/v1/tools/delete_trading_trigger | Premium | Permanently delete a trigger. |
POST /api/v1/tools/list_fired_triggers | Free | List triggers that already fired. |
POST /api/v1/tools/list_trading_triggers | Free | List active and paused triggers. |
POST /api/v1/tools/preview_trading_trigger | Free | Preview a trigger before creating it. |
POST /api/v1/tools/reactivate_trigger | Premium | Reactivate a fired trigger. |
POST /api/v1/tools/update_trading_trigger | Premium | Update a trigger (pause / retarget). |
Strategy
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/autofetch_strategy | Premium | Auto-pick the best-matching strategy. |
POST /api/v1/tools/fetch_strategy | Premium | Load one strategy by id. |
POST /api/v1/tools/list_strategy | Premium | List your strategies. |
POST /api/v1/tools/create_strategy | Premium | Create a new strategy. |
POST /api/v1/tools/strategy_import | Premium | Copy a public strategy into your account. |
POST /api/v1/tools/open_strategy | Premium | Open the user’s primary strategy. |
POST /api/v1/tools/strategy_preview | Premium | Preview proposed strategy edits. |
POST /api/v1/tools/save_strategy_instructions | Premium | Save strategy-selection instructions. |
POST /api/v1/tools/strategy_discover | Free | Browse the strategies other people share. Search by title or content, then import one with Strategy-Import. |
POST /api/v1/tools/strategy_duplicate | Premium | Make your own copy of a shared strategy. The same thing as Strategy-Import, under the other name. |
POST /api/v1/tools/update_strategy | Premium | Save changes to an existing strategy. |
Workflow
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/list_tool_safety | Free | List which tools are read-only / destructive. |
POST /api/v1/tools/trigger_workflow_schema | Free | Field schema for trigger / workflow rules. |
POST /api/v1/tools/workflow_apply_updates | Premium | Pull the latest revisions from the parent workflow into this subscribed copy. Use when revisions_behind > 0. |
POST /api/v1/tools/workflow_create | Premium | Create a new perception workflow. |
POST /api/v1/tools/workflow_delete | Premium | Permanently delete a workflow. |
POST /api/v1/tools/workflow_export | Free | Export a workflow's full node-and-edge graph plus a self-describing markdown rendering. Read-only. |
POST /api/v1/tools/workflow_import | Premium | Copy a public workflow into your account. |
POST /api/v1/tools/workflow_list | Free | Lightweight programmatic discovery, list every workflow you own with id / name / status / schedule. Read-only. Use before Workflow-Export / Workflow-Logs / Workflow-Run when you need an id. |
POST /api/v1/tools/workflow_logs | Free | Read recent workflow runs. |
POST /api/v1/tools/workflow_open | Free | Open a workflow for review / editing. |
POST /api/v1/tools/workflow_performance | Free | Closed-trade performance for a workflow: per-trade PnL rows and aggregate Win Rate / Total PnL / win-loss-flat counts / calendar-style by_day map. |
POST /api/v1/tools/workflow_preview | Free | Preview proposed workflow edits. |
POST /api/v1/tools/workflow_run | Premium | Execute a workflow on demand. |
POST /api/v1/tools/workflow_update | Premium | Save changes to a workflow. |
POST /api/v1/tools/workflow_discover | Free | Browse the workflows other people share, most imported first. Search by name, rules, or tool. Import one with Workflow-Import. |
POST /api/v1/tools/workflow_duplicate | Premium | Make your own copy of a shared workflow. The same thing as Workflow-Import, under the other name. |
POST /api/v1/tools/workflow_journal | Premium | Read or change a workflow's journal. With journalling on, Atlas writes a note after each of its trades finishes and reads those notes back on later runs. |
Account
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/get_instructions | Free | Read your saved strategy-selection instructions. |
POST /api/v1/tools/get_subscription_status | Free | Subscription tier, usage, remaining requests. |
POST /api/v1/tools/account_activity | Free | What has happened on your account lately: every workflow and task run with its reasoning and any error, plus the trades those runs fired. Newest first. |
Search
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/fetch | Free | Fetch and summarize a URL. |
POST /api/v1/tools/search | Free | General Atlas search. |
POST /api/v1/tools/web_search | Premium | Live web search for real-time news and facts, today's headlines, macro / geopolitical drivers, earnings, and current events, returned as a dated answer plus the source links it used. |
POST /api/v1/tools/resolve_ticker | Free | Resolve a company name to its ticker. |
Alerts
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/list_alert_types | Premium | Catalog of alert types you can create, read this BEFORE Create-Alert to learn the conditions shape for each type. |
POST /api/v1/tools/list_alerts | Premium | Your streaming alerts. Active-only by default; pass active_only=false to include disarmed / cascade-paused. |
POST /api/v1/tools/preview_alert | Premium | Dry-run an alert spec against the live tape, returns what would have matched without creating the alert. |
POST /api/v1/tools/create_alert | Premium | Create a streaming alert that DMs Discord on fire and optionally arms a trigger / runs a workflow / places an order. ⚠️ Read List-Alert-Types first. |
POST /api/v1/tools/update_alert | Premium | Patch an existing alert in place (rename, change conditions, retarget workflow_id, flip is_active, etc.). |
POST /api/v1/tools/delete_alert | Premium | Soft-delete an alert by flipping is_active=false. The row stays for audit. |
POST /api/v1/tools/list_stream_subscriptions | Premium | Active streaming subscriptions the worker is holding open (flow tape, option quote feeds), useful for debugging why an alert isn't firing. |
Tasks
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/list_tasks_tool | Free | List your TASKS (run-once automations). Each is 'upcoming' (active/paused, fires still ahead) or 'previous' (completed). |
POST /api/v1/tools/create_task_tool | Premium | Create a run-once task (a workflow that does not recur). Arm it with scheduled times (each fires once), an alert (fires once on the first match), or manual. |
POST /api/v1/tools/update_task_tool | Premium | Update a task you own, pass task_id plus a patch object of fields to change. patch.status 'paused' turns it off, 'active' turns it on. |
POST /api/v1/tools/run_task_tool | Premium | Run a task once, right now. |
POST /api/v1/tools/delete_task_tool | Premium | Delete a task you own. |
Workflow: Folders
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/workflow_folders_list | Free | List your workflow folders and which workflows are filed in each. Folders only organize the list, they never change how a workflow runs. |
POST /api/v1/tools/workflow_folder_create | Premium | Make a folder to organize your Workflows list. You can file workflows into it right away. |
POST /api/v1/tools/workflow_folder_update | Premium | Rename a folder, change its colour, or move it up or down the list. |
POST /api/v1/tools/workflow_folder_move | Premium | File one or more of your workflows into a folder. A workflow sits in one folder at a time, so this takes it out of any other. |
POST /api/v1/tools/workflow_folder_remove | Premium | Take workflows out of a folder. The workflows are not deleted, they just go back to being loose in your list. |
POST /api/v1/tools/workflow_folder_disband | Premium | Delete a folder. The workflows inside are not deleted, they go back to being loose in your list. |
Workflow: Working together
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/workflow_collab_list | Free | See who works on a workflow with you: its author and the people invited to help build it. Read only, on purpose, only the author adds or removes people. |
POST /api/v1/tools/workflow_proposal_list | Free | List the changes people have suggested to a workflow, what each one touches, whether it is still open, and whether it went stale because the author edited since. |
POST /api/v1/tools/workflow_proposal_show | Free | Read one suggested change in full, with what the workflow said before, what it would say, and what it says right now. |
POST /api/v1/tools/workflow_proposal_comment | Premium | Leave feedback on a suggested change. Name a part of the change to attach the note to that part instead of the whole thing. |
Trading: Open trades
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/trade_list | Free | The positions you are in right now, wherever they came from: a workflow, a task, a play you took, or a trigger you set up. Each one shows its take profit levels and which have already sold. |
POST /api/v1/tools/trade_close | Premium | Close a position now, everything still open on it, at market. Only the person who owns the trade can close it. A real position needs a market, so outside 9:30 to 4 Eastern this refuses. |
POST /api/v1/tools/trade_take_profit | Premium | Sell the next take profit rung now, without waiting for its price. One rung per call. To take everything at once use Trade-Close. |
POST /api/v1/tools/trade_cancel_entry | Premium | Take an order off before it fills. Only while the entry is still waiting at its price, once it has filled the way out is Trade-Close. |
Signals
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/signal_schema | Free | Read this before posting or taking a play. The shape of a play: every field, what each number is measured in, what happens when one is left out, and worked examples. |
POST /api/v1/tools/signal_groups | Free | The places you can post a play to: the community board, plus every signal group you own or can post in. |
POST /api/v1/tools/signal_list | Free | Read the plays on the community board, or the private ones, newest first, with what happened to you on each. One page at a time. |
POST /api/v1/tools/signal_show | Free | Show one play as a card, the same one the Signals tab renders, with every number and what happened to your order. |
POST /api/v1/tools/signal_post | Premium | Post a trade play to the community board or one of your groups: the contract, how much, where to get in, where to take profit, where to get out, and when. |
POST /api/v1/tools/signal_update | Premium | Change a play that is still live instead of posting a second one. Send only what changes, everything left empty keeps what the play already says. |
POST /api/v1/tools/signal_take | Premium | Take a play: place it in your own account, now. This places a real order. Nothing on the board trades on its own. |
POST /api/v1/tools/signal_broker | Premium | See or set the broker account your plays go to, and whether it is used automatically for plays you post and plays you take. |
Guide
| Endpoint | Plan | What it does |
|---|---|---|
POST /api/v1/tools/atlas_guide_index | Free | The Atlas guide's table of contents: every topic, grouped, with the id and link for each. Start here, then read the one that matches. |
POST /api/v1/tools/atlas_guide_search | Free | Search the guide for a word or phrase and get the topics that mention it, each with a snippet and a link. |
POST /api/v1/tools/atlas_guide_read | Free | Read one topic of the guide in full, by its id. Returns the whole page and its link, the same text the docs site shows. |