Quickstart
1. Get an API key
Sign in at api.tradeflags.com/account and press Get API Key. The free tier allows 1,000 calls a month with no card; the paid tiers are on the Rate limits page. Keep the key private — it is the only credential your agent needs.
2. Connect your agent
The TradeFlags MCP server is one remote endpoint. Connect it once and all 35 tools are available. The tools are grouped into packages (vol-surface, accumulator, network, breadth, …) for discovery, but a single connection serves the whole catalogue — there is no separate install per package.
Claude Code
From your project root, add the server on the CLI:
claude mcp add tradeflags --transport http \
--url https://api.tradeflags.com/mcp \
--header "Authorization: Bearer tf_live_YOUR_KEY"
…or create a .mcp.json in the project root:
{
"mcpServers": {
"tradeflags": {
"type": "http",
"url": "https://api.tradeflags.com/mcp",
"headers": { "Authorization": "Bearer tf_live_YOUR_KEY" }
}
}
}
Hermes
Add a server under mcp_servers in ~/.hermes/config.yaml:
mcp_servers:
tradeflags:
url: "https://api.tradeflags.com/mcp"
headers:
Authorization: "Bearer tf_live_YOUR_KEY"
Restart the agent. Its tools appear as mcp_tradeflags_*.
3. Worked examples
Price an accumulator
Ask your agent to call accumulator__price with a stock and a variant:
Price a ko_fixed accumulator on 0700 at 2.0x leverage.
The tool solves the structure to net-zero NPV and returns spot, accrual level, knock-out barrier, NPV and
the Greeks. Use otc_pricing__price when you want to pin the strike, barrier and base level
yourself instead of having the solver pick them.
Request a data series
Ask for ads__index to get the latest Aruoba-Diebold-Scotti business-conditions reading and
its regime. Every tool states its units and the session it describes, so the agent knows what it is getting
without a schema lookup.
Evaluate an investment decision
An agent combines tools. To weigh an entry into Hong Kong equities it can pull ads__index
(US business cycle), moirai__forecast (HK distribution forecast) and
network__valuation (peer-relative valuation) and reconcile the three. The prompt below is the
shape to use.
4. Example prompt
I am considering adding Hong Kong equities to a portfolio this month.
Using the TradeFlags MCP tools, walk me through the current picture:
1. ads__index — what is the US business-cycle regime right now?
2. moirai__forecast — what is the P10 / median / P90 HK outlook over the next 30 days?
3. network__valuation — which sectors look cheapest relative to their peers?
Then give me a one-paragraph, clearly-caveated read on whether the risk/reward
favours waiting, and cite the numbers you used for each conclusion.
5. Check what you are being charged
Every call is metered against your tier, and your usage is visible on the account page. See Rate limits for the tiers and the metering rules.