stocksbrew

Recherche sur les actions américaines pour votre agent : pages d’actions, recommandations datées, synthèses de marché, filtres et votre radar. Nécessite un compte stocksbrew Pro (OAuth ou jeton personnel).

Serveur MCP hébergé

npx add-mcp 'https://www.stocksbrew.online/api/mcp'

S’installe dans Claude Code, Codex, Cursor et plus

Documentation

Tools

23

19 read, 4 write

Per day

200

calls, resets at midnight UTC

Per minute

30

calls

Plan

Pro

required for every call

Quickstart

Pick the one that matches what you are connecting. All three reach the same tools and count against the same allowance.

1. An agent, over MCP with OAuth

The MCP server is at https://www.stocksbrew.online/api/mcp. It speaks streamable HTTP and uses OAuth, so your token never goes into the conversation. In Claude Code:

claude mcp add --transport http stocksbrew https://www.stocksbrew.online/api/mcp
# then run /mcp inside Claude Code and sign in when the browser opens

In a client with an MCP settings screen (Cursor, Codex, the Claude and ChatGPT web apps), add a remote server with that URL and approve the sign-in. Or paste this prompt into a coding agent and let it do the setup:

Use this prompt in Codex or Claude Code for direct MCP setup. ChatGPT and Claude mobile apps cannot add Stocksbrew from a pasted prompt; connect it from their web app settings first.

Connect to Stocksbrew's remote MCP server:

https://www.stocksbrew.online/api/mcp

Use OAuth. After connecting, verify the setup by showing my Watchlist and its latest changes.

Stocksbrew gives you four kinds of read access:
1. My Watchlist and holdings: use get_my_radar and get_radar_changes.
2. Explore: use get_explore for the Explore page's trending, heat, 52-week, Reddit and Trump sections.
3. Full stock detail: use get_stock_detail for the stock page's facts, financial history, valuation, balance sheet, dividends, business mix, institutions, price history, technicals, AI business questions, earnings, news and Reddit context.
4. Screens: use get_screens for Stocksbrew's curated thematic screen catalog and matches.

When I ask about a stock, call get_stock_intelligence for a concise current read. Call get_stock_detail when I ask for the full stock page or deeper evidence. If a field is missing, say "not enough current evidence"; never fill gaps with an invented thesis. If detailed research is missing, explain what data is available and ask before using add_to_radar to queue or refresh research. Recheck the stock later when research is queued or running.

You may read my Watchlist and alerts. Ask for my confirmation before adding or removing a Watchlist stock, or creating or deleting a price alert. Use get_radar_changes for earnings, RSI, call, anomaly and news updates. Never place trades or claim Stocksbrew can access a brokerage.

If you cannot add the server automatically, give me the exact setup steps for this client. Never ask me to paste an access token into chat.
Uses OAuth. Your access token stays out of the conversation.

2. A client that wants a bearer header

Create a personal token under Account and put it in the client's config. Keep the config file out of version control.

{
  "mcpServers": {
    "stocksbrew": {
      "url": "https://www.stocksbrew.online/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_STOCKSBREW_TOKEN"
      }
    }
  }
}

3. Your own code, over REST

Every path is under https://www.stocksbrew.online/api/v1 and takes the same token.

export STOCKSBREW_TOKEN="sbp.…"   # create one under Account, shown once

curl -s "https://www.stocksbrew.online/api/v1/stocks/NVDA" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

4. A terminal

npm install -g stocksbrew-cli
export STOCKSBREW_TOKEN="sbp.…"

stocksbrew stock NVDA
stocksbrew search "nvidia"
stocksbrew market

Auth and tokens

Every call needs a bearer token that belongs to an account with an active Pro plan. There are two kinds.

OAuth access token

Issued when you approve a client in the browser. Starts with sbo. and lasts 1 hour. The client renews it with a refresh token (sbr., 30 days, single use: each refresh returns a new one).

Personal token

Created by you under Account. Starts with sbp., does not expire, and carries all six scopes. Up to 5 active at once. Shown once at creation: we store a SHA-256 hash of the secret and cannot show it again.

Revoking

Revoke a personal token under Account and it stops working on the next call. If a token is exposed, revoke it and create another.

When Pro ends

Calls return pro_required. Tokens are not deleted, so they work again if the plan is renewed.

Scopes

An OAuth client asks for scopes and you see them on the consent screen before you approve. Grant the smallest set that does the job.

ScopeAllowsTools
stocks:readRead stock research: the call, zones, fundamentals, risks, what a company changed in its filed risks, full stock detail and comparisons, and read a watch request in plain words.search_stocks, get_stock_intelligence, get_stock_detail, compare_stocks, watch_in_plain_words, get_filing_changes
market:readRead the market brief, Explore sections, screens, the copy tests and the Market Daily archive.get_market_brief, get_market_history, get_explore, get_screens, copy_test
radar:readRead your own portfolio: the stocks you hold and watch, what changed, what your funds hold, your dividends, your stress test and your idea baskets.get_my_radar, get_radar_changes, what_you_own, dividend_plan, stress_test, list_baskets, get_basket
radar:writewriteAdd a stock to your portfolio or remove one.add_to_radar, remove_from_radar
alerts:readRead your active alerts.get_my_alerts
alerts:writewriteCreate a price alert or deactivate an alert.create_alert, delete_alert

OAuth, for client authors

Flow

Authorization code with PKCE. S256 is required. Public clients only: the token endpoint takes no client secret.

Discovery

https://www.stocksbrew.online/.well-known/oauth-authorization-server

Protected resource

https://www.stocksbrew.online/.well-known/oauth-protected-resource

Registration

Dynamic client registration is open. Redirect URIs must be https, or http on localhost.

401 challenge

An unauthenticated call returns WWW-Authenticate with the resource metadata URL, so a compliant client can start the flow on its own.

Rate limits

Two limits, counted per account across MCP, REST and the CLI together. Every call counts, including one that returns an error from our data.

Daily

200 calls per day. The day is a UTC day: the counter resets at 00:00 UTC.

Burst

30 calls per minute, by clock minute.

When you hit one

HTTP 429 with a Retry-After header in seconds: 60 for the minute limit, the time until midnight UTC for the daily limit. Over MCP the tool returns an error result with the same code.

Knowing where you stand

Every successful response carries a usage object. Today's count is also shown under Account.

"usage": { "used": 12, "remaining": 188, "limit": 200, "period": "day" }
HTTP/1.1 429 Too Many Requests
Retry-After: 60
Cache-Control: no-store

{"error":"minute_limit","message":"Per-minute agent limit of 30 calls reached."}

What comes back

Every tool returns one JSON object. Over MCP it arrives as structured content and as text. Over REST it is the response body, never cached.

schema_version

The contract date, currently 2026-08-18.

as_of

The time of the freshest input behind the response. Null when there is nothing to date.

freshness

status, age_hours and a relative label. Use it to tell the person how old the data is.

notice

A short standing notice: informational use, data may be delayed or wrong, not advice, not a broker.

usage

Calls used and remaining today.

the data

The tool's own fields beside those. A field we do not hold is null or an empty list. It is never filled with a guess.

Research states

get_stock_intelligence returns coverage.status and coverage.next_action. Treat the status as fact and the next action as the instruction for what to do about it.

ready

A full call exists. Use it.

queued

Research has been requested and is waiting to run. Check again later.

running

Research is being written now. Check again later.

baseline_only

We have prices and facts but no call. Ask the person before adding the stock to their portfolio to queue research.

no_sources

Research ran and found nothing recent to build a call from.

failed

Research ran and failed.

unavailable

We hold nothing for this stock.

Tool reference

Each tool has the same name over MCP and a route over REST.

Stocks

Research on any stock we cover, and what it changed in its filed risks.

Find stocksbrew instruments by ticker or company name. Use this before requesting intelligence when the ticker is ambiguous.

ArgumentTypeNotes
querystringrequiredTicker or company name. up to 100 characters
marketstringoptionalListing market. US | IN, default "US"
limitintegeroptional1 to 20, default 10

REST: GET /api/v1/stocks/search · The search text is q over REST and query over MCP.

curl example

curl -s "https://www.stocksbrew.online/api/v1/stocks/search?q=nvidia&limit=5" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Get the current Stocksbrew call, zones, target context, drivers, risks, fundamentals, technical setup, freshness and research status for one stock. If a brief is missing, follow coverage.next_action and ask before adding the stock to Watchlist.

ArgumentTypeNotes
tickerstringrequiredTicker symbol or stocksbrew instrument ID. up to 20 characters
marketstringoptionalUS | IN, default "US"

REST: GET /api/v1/stocks/{symbol}

curl example

curl -s "https://www.stocksbrew.online/api/v1/stocks/NVDA" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Get the complete materialized stock-page data for one stock: facts, financial history, valuation, balance sheet, dividends, business mix, institutions, price history, technicals, the five business questions, earnings, recent news, Reddit context and anomalies. Missing fields remain null or empty; say not enough current evidence instead of inferring them.

ArgumentTypeNotes
tickerstringrequiredTicker symbol or stocksbrew instrument ID. up to 20 characters
marketstringoptionalUS | IN, default "US"

REST: GET /api/v1/stocks/{symbol}/detail

curl example

curl -s "https://www.stocksbrew.online/api/v1/stocks/NVDA/detail" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Compare 2 to 5 stocks across valuation, growth, quality, momentum, targets, returns, and technical context.

ArgumentTypeNotes
tickersstring[]required2 to 5 items

REST: POST /api/v1/compare

curl example

curl -s -X POST "https://www.stocksbrew.online/api/v1/compare" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tickers":["MSFT","GOOGL","AMZN"]}'

What one US company added to, dropped from or reworded in the risk factors of its newest 10-K or 10-Q, against the filing before it, with both filings' dates and SEC links. Every risk is the company's own heading, copied from the filing. Read data_status first: no_comparison and unreadable mean there is nothing to report, so say that and do not guess.

ArgumentTypeNotes
tickerstringrequiredUS ticker symbol, such as AMD. up to 20 characters

REST: GET /api/v1/stocks/{symbol}/filing-changes

curl example

curl -s "https://www.stocksbrew.online/api/v1/stocks/AMD/filing-changes" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Market

What the market and our discovery lists look like now.

Get Stocksbrew's current market read, sentiment, macro cards, sector flows, and leading movers with freshness metadata.

ArgumentTypeNotes
marketstringoptionalUS | IN, default "US"

REST: GET /api/v1/market

curl example

curl -s "https://www.stocksbrew.online/api/v1/market" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Get the current Explore page sections: trending names, hot and momentum setups, news spikes, catalyst and dip setups, 52-week highs and lows, Reddit buzz and recent Trump mentions.

ArgumentTypeNotes
marketstringoptionalUS | IN, default "US"

REST: GET /api/v1/explore

curl example

curl -s "https://www.stocksbrew.online/api/v1/explore" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Get Stocksbrew's curated thematic screen catalog, coverage metadata and every current match with the fields used by the Screens page.

ArgumentTypeNotes
marketstringoptionalUS | IN, default "US"

REST: GET /api/v1/screens

curl example

curl -s "https://www.stocksbrew.online/api/v1/screens" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Read archived US Market Daily editions. Publication is paused, so do not use this history as current market context. Use days to request up to 30 editions.

ArgumentTypeNotes
marketstringoptionalUS | IN, default "US"
daysintegeroptionalNumber of published editions to return. 1 to 30, default 7

REST: GET /api/v1/market/history

curl example

curl -s "https://www.stocksbrew.online/api/v1/market/history?days=7" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Your portfolio

The stocks on your account. Writes change your account.

Get the authorized Pro member's tracked stocks, current calls, target room, portfolio context and Watchlist summary.

ArgumentTypeNotes
limitintegeroptional1 to 100, default 50
offsetintegeroptional0 or more, default 0

REST: GET /api/v1/radar

curl example

curl -s "https://www.stocksbrew.online/api/v1/radar?limit=50&offset=0" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Get new changes and upcoming events across the authorized member's Watchlist.

ArgumentTypeNotes
sincestringoptionalOnly return attention items after this ISO timestamp. Use the returned cursor on the next poll.. ISO 8601 time

REST: GET /api/v1/radar/changes

curl example

curl -s "https://www.stocksbrew.online/api/v1/radar/changes?since=2026-11-08T21:00:00Z" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Add a stock to the member's Watchlist and queue missing research. This changes the member's account. Ask for confirmation before calling it.

ArgumentTypeNotes
tickerstringrequiredup to 20 characters
marketstringoptionalUS | IN, default "US"
position_typestringoptionalwatchlist | holding, default "watchlist"

REST: POST /api/v1/radar

curl example

curl -s -X POST "https://www.stocksbrew.online/api/v1/radar" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"NVDA","position_type":"watchlist"}'

Remove a stock and its holding context from the member's Watchlist. Ask for confirmation before calling it.

ArgumentTypeNotes
tickerstringrequiredup to 20 characters
marketstringoptionalUS | IN, default "US"

REST: DELETE /api/v1/radar

curl example

curl -s -X DELETE "https://www.stocksbrew.online/api/v1/radar" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"NVDA"}'

Inside your portfolio

What your holdings own through funds, pay in dividends and did in past shocks.

Open up the member's funds and add what is inside them to the stocks they bought: their real stake in each company (direct vs through funds), sectors against the S&P 500, how much their funds overlap, and the read the page shows. Fund holdings come from each fund's SEC N-PORT filing. Read data_status first: no_holdings, no_values and no_funds mean there is little or nothing to show.

ArgumentTypeNotes
limitintegeroptionalHow many companies to return, biggest first. 1 to 50, default 15

REST: GET /api/v1/portfolio/xray

curl example

curl -s "https://www.stocksbrew.online/api/v1/portfolio/xray?limit=15" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

What the member's holdings should pay over the next twelve months, month by month and per stock, with announced dividends kept apart from estimates based on each stock's last year of payments. Holdings without a share count are listed in missing_shares and add nothing to the totals.

ArgumentTypeNotes
paymentsbooleanoptionalInclude every planned payment for each stock, not only the next one. default false

REST: GET /api/v1/portfolio/dividends

curl example

curl -s "https://www.stocksbrew.online/api/v1/portfolio/dividends?payments=true" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

How the member's holdings, at today's weights, did in eight real market shocks and rallies of the last decade, each next to the S&P 500, from their own daily closes. It is history, not a forecast. Each episode names the holding that did the most; ask for holdings to get every holding's move.

ArgumentTypeNotes
holdingsbooleanoptionalInclude every holding's move in each episode. default false

REST: GET /api/v1/portfolio/stress

curl example

curl -s "https://www.stocksbrew.online/api/v1/portfolio/stress?holdings=true" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Copy tests

What copying a fund or a House member would have made.

What copying a 13F fund's filings or a House member's reported trades would have made against the S&P 500, traded the first close after each disclosure became public. With slug or query: one record (a query that matches several returns their slugs to pick from). With neither: the ranking of every fund and member. A historical test on paper, before costs and taxes; the future can differ.

ArgumentTypeNotes
slugstringoptionalA record's slug, such as berkshire-hathaway. up to 100 characters
querystringoptionalFund, manager or House member name to search. up to 100 characters
kindstringoptionalOnly funds or only House members. fund | congress
limitintegeroptionalRanked rows to return per kind, when listing. 1 to 50, default 10

REST: GET /api/v1/copy

curl example

curl -s "https://www.stocksbrew.online/api/v1/copy?query=berkshire" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Alerts

Your alert rules. Agents can create price alerts only.

List active Stocksbrew alerts, optionally filtered to one stock or alert kind.

ArgumentTypeNotes
tickerstringoptionalup to 20 characters
marketstringoptionalUS | IN, default "US"
kindstringoptionalprice_threshold | anomaly | rsi_extreme | earnings_24h | directive_change | news_velocity
limitintegeroptional1 to 100, default 50

REST: GET /api/v1/alerts

curl example

curl -s "https://www.stocksbrew.online/api/v1/alerts?ticker=NVDA" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Create a price threshold email alert. Ask for confirmation before calling it. Use get_radar_changes for earnings, RSI, call, anomaly, and news updates.

ArgumentTypeNotes
tickerstringrequiredup to 20 characters
marketstringoptionalUS | IN, default "US"
kindstringoptionalalways "price_threshold"
conditionstringoptionalbelow | above
target_pricenumberoptionalabove 0
notestringoptionalup to 240 characters

REST: POST /api/v1/alerts

curl example

curl -s -X POST "https://www.stocksbrew.online/api/v1/alerts" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"NVDA","condition":"below","target_price":190}'

Deactivate one alert owned by the member. Ask for confirmation before calling it.

ArgumentTypeNotes
alert_idstringrequiredup to 200 characters

REST: DELETE /api/v1/alerts

curl example

curl -s -X DELETE "https://www.stocksbrew.online/api/v1/alerts" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alert_id":"ALERT_ID"}'

Agents

Read a watch request into stocksbrew agents. Saving happens on the Agents page.

Read a plain-English request such as "tell me if NVDA closes below 150 or a fund sells it" into the stocksbrew agents it would make, with the sentences the Agents page shows and anything it cannot watch. This only reads the request; nothing is saved. To switch the agents on, the member types the request on the Agents page.

ArgumentTypeNotes
textstringrequiredWhat to watch, in the member's own words. up to 300 characters

REST: POST /api/v1/agents/parse

curl example

curl -s -X POST "https://www.stocksbrew.online/api/v1/agents/parse" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"tell me if NVDA closes below 150"}'

Idea baskets

Your ideas, each company's reason and what the last check found. Changes happen in the app.

The member's idea baskets: ideas an agent checks after every close. For each, its companies with the latest check's verdict on each reason (holds, weaker, broken, played out, not checked) and the fact behind it, and what that check decided. Read only: baskets are created, switched on and changed in the app.

No arguments.

REST: GET /api/v1/baskets

curl example

curl -s "https://www.stocksbrew.online/api/v1/baskets" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

One of the member's idea baskets in full: every company's reason and verdict, what the latest check decided and the changes it proposes, the checks before it, and the four-week replay it ran before it started. Use an id from list_baskets. Read only.

ArgumentTypeNotes
basket_idstringrequiredA basket id from list_baskets. up to 24 characters

REST: GET /api/v1/baskets/{id} · The id goes in the path over REST and in basket_id over MCP.

curl example

curl -s "https://www.stocksbrew.online/api/v1/baskets/BASKET_ID" \
  -H "Authorization: Bearer $STOCKSBREW_TOKEN"

Errors

REST errors are JSON with error and message. Over MCP the same code arrives in an error result. Match on the code, not the message.

CodeHTTPMeaning
invalid_token401No bearer token, or one that is malformed, revoked or expired.
pro_required403The account behind the token does not have an active Pro plan.
insufficient_scope403The token was not granted the scope this tool needs.
minute_limit429Too many calls in the current minute. Retry-After is 60 seconds.
daily_limit429The day's allowance is used. Retry-After is the seconds until midnight UTC.
stock_not_found404The ticker is not in our catalog for that market.
invalid_ticker400The ticker is empty or longer than 20 characters.
invalid_query400The search text is empty.
invalid_tickers400A comparison needs between 2 and 5 different tickers.
invalid_alert_kind400The alert kind is unknown, or is one agents cannot create. Agents create price_threshold alerts only.
invalid_condition400A price alert needs condition above or below.
invalid_target_price400A price alert needs a positive target_price.
alert_exists409An identical active alert is already set.
alert_not_found404No alert with that id belongs to this account.
email_required409The account has no email address to send alerts to.
profile_not_ready409The account has not finished setting up. Open the app once and retry.
invalid_slug400The copy test slug has characters a slug cannot have.
copy_test_not_found404No copy test has that slug, or no fund or House member matches the search.
copy_tests_unavailable503The copy tests could not be loaded. Retry later.
portfolio_unavailable503Your holdings could not be read just now. Retry in a minute.
invalid_request400The watch request is empty or longer than 300 characters.
plain_parse_limit429The day's plain-English requests are used up, shared with the Agents page.
basket_not_found404No idea basket with that id belongs to this account.
invalid_basket_id400The basket id is empty.
baskets_unavailable503Your idea baskets could not be read just now. Retry in a minute.
market_unavailable503The market brief could not be loaded. Retry later.
screens_unavailable503The screen catalog could not be loaded. Retry later.
internal_error500Something failed on our side.

Example prompts

Things to say to an agent once it is connected. Each one is answerable from the tools listed under it.

Read my stocksbrew portfolio changes since yesterday's close. For each change tell me what happened, the source and its time. If nothing changed, say so in one line.

uses get_radar_changes, get_my_radar

Give me the current stocksbrew read on NVDA: the call, the zones, the top two drivers and the main risk. Quote the as_of time. If research is missing, tell me what is available and ask before adding it to my portfolio.

uses get_stock_intelligence, add_to_radar (only after a yes)

Which of my holdings report in the next seven days? For each, pull the full stock detail and summarise what the report has to show, using only fields that are present.

uses get_my_radar, get_stock_detail

Compare MSFT, GOOGL and AMZN on valuation, growth and one-year return using stocksbrew. Put the numbers in a table and note any field that came back empty.

uses compare_stocks

Set a stocksbrew alert for AAPL below 200. Show me exactly what you are about to create and wait for my yes.

uses create_alert (after confirmation), get_my_alerts

Using stocksbrew, tell me what I really own once my funds are opened up, what my holdings should pay me in dividends over the next year, and how they did in the 2022 rate-hike slide. Quote the sentences and dates it gives.

uses what_you_own, dividend_plan, stress_test

What would copying Berkshire Hathaway's 13F filings have made against the S&P 500? Then show me the top five funds on stocksbrew's copy ranking.

uses copy_test

Read this into stocksbrew agents and show me what it would watch: tell me if NVDA closes below 150 or a fund sells it.

uses watch_in_plain_words

What did AMD add to or drop from its risk factors in its newest 10-K or 10-Q? Quote each risk as filed, with the filing date and the SEC link. If stocksbrew has no comparison, say so.

uses get_filing_changes

Go through my stocksbrew idea baskets. For each, tell me which companies' reasons are weaker or broken, the fact behind it, and what the last check proposed.

uses list_baskets, get_basket

From stocksbrew's Explore data, list today's names with a news spike and a confirmed reason. Leave out any mover without one.

uses get_explore, get_market_brief

Two habits worth building into any prompt: ask the agent to quote as_of, and tell it to say not enough current evidence when a field is empty instead of filling the gap.

CLI

A thin client for the REST API, for a terminal or a shell script. It prints the JSON response.

Install

npm install -g stocksbrew-cli

Needs

Node 18 or newer.

stocksbrew stock SYMBOL

The current read on one stock (get_stock_intelligence).

stocksbrew search QUERY

Find a ticker by name (search_stocks).

stocksbrew market

The market brief (get_market_brief).

stocksbrew explore

The Explore sections (get_explore).

stocksbrew openapi

Print the OpenAPI document. The only command that needs no token.

Token

Set STOCKSBREW_TOKEN or pass --token. Prefer the environment variable so the token stays out of your shell history.

Exit code

0 on success, 2 when the request fails. The error is printed to stderr as JSON.

The CLI covers the commands above. Every other tool, including portfolio, alerts, copy tests and agents, is available over MCP and REST.

What it is not for

The same limits as the rest of the product, plus a few that apply to programmatic access.

  • No trading. There is no tool that places, changes or cancels an order, and no brokerage connection behind the API.
  • Personal use: your own agents, scripts and internal workflows. Not for serving another product's users.
  • No bulk download, mirroring, resale or redistribution of our data or of results derived from it.
  • Write tools change your account. A well-behaved agent asks you before calling one, and the tool descriptions tell it to.
  • An agent can combine our output with its own guesses. Check the as_of time and the source before you act on an answer.

The full terms are in the terms of service. How tokens and account data are handled is on Security. Looking for agents that watch your stocks inside the app, with no code? That is Agents.