Quickstart

The agent-readable guides: finterm.ai/llms.txt for setup and worked examples, and docs.finterm.ai/llms.txt for the API surface and per-tool endpoints.

# 1. Install
npm install -g @finterm-ai/cli

# 2. Authenticate in a browser (lands you on the pricing page, terminal connected)
finterm auth login

#    Headless alternative: paste the dashboard key
export FINTERM_API_KEY="fint_auth_..."

# 3. Activate: start your 3-day free trial (card required) at
#    https://app.finterm.ai/pricing; trial and Pro activate together.

# 4. First data call
finterm tool financial_statements NVDA --statement-type income_statement --timeframe quarterly

Every authenticated data and tool call requires Finterm Pro (there is no free data tier). Without it, calls return 402 SUBSCRIPTION_REQUIRED with the machine-readable error.upgrade_url. After checkout, re-run the command; access activates automatically. A 401 means the key itself is missing or was rotated. Two endpoints work with any authenticated key, Pro or not: GET /api/v1/account (plan status) and POST /api/v1/feedback (finterm feedback: bug reports, questions, and feature requests, straight from the CLI). Integrating against the API directly (no CLI)? Mint a key from the dashboard at app.finterm.ai/dashboard and call any documented endpoint:

curl -X POST https://api.finterm.ai/api/v1/prices/current \
  -H "Authorization: Bearer $FINTERM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symbols":["NVDA"]}'

Setting up a coding agent? finterm setup installs the Finterm skills and finterm prime orients the agent. Check your plan any time with finterm auth status.

Getting Started

CLIs

Point Tools

Bundle Tools