logo
    logo
    Log in
    Browse help/API and MCP

    API and MCP

    Available on: Web

    On this page

    The scanr API runs the same scans you build in the app, from your own code. The MCP server hands those scans to an AI assistant such as Claude Code or Cursor as tools it can call. Both use an API token from your account. The developer docs at api-docs.scanr.ai cover every endpoint and tool.

    What you need

    1. An API add-on. API access is billed apart from your plan. You can add it to any plan, Free included, and your plan's limits don't apply to API calls. Every API tier includes the MCP server.
    2. A way to sign in. An AI assistant signs in with OAuth: you approve it on scanr.ai and it gets its own token. For your own code, or if you prefer, create an API token on the web, under your account.

    The add-on comes in three tiers: Starter, Power User and Ultimate. They differ in requests per minute, hour and day, in daily AI credits, and in how long scan results are reused: Power User can lower that to 30 seconds, and Ultimate can turn the cache off. See prices on scanr.ai/api-pricing and every limit in Plans & Rate Limits. The Starter API tier is paid. It isn't the Free plan, which the pricing page also calls Starter.

    Each tier also sets your support:

    • Starter: email support. We reply within one business day.
    • Power User: email support, plus the shared #scanr-api Slack channel with the team. Request your invite under Account > Support. You join as a guest and see only that channel.
    • Ultimate: everything in Power User, a reply the same business day, a 1:1 onboarding call with Eoin, the founder, that you book under Account > Support, and early access to new endpoints, datasets and MCP tools.

    Business days are Monday to Friday, 9am to 5pm ET. If you move down to Starter or the add-on ends, we remove you from the Slack channel.

    Add API access

    1. Go to Account > Plans and Upgrades.
    2. In the API access row, click Add API access and choose a tier.

    To change or cancel the add-on later, use the same row. Canceling your app plan leaves the API add-on running.

    Create a token

    1. Go to Account > API Tokens.
    2. Click Create new token.
    3. Give the token a Token name, such as the app or assistant that will use it.
    4. Pick a Permission. Read runs scans and reads market data and your saved scans. Read & write can also save, edit, share and delete your scans. Read & write is selected to start with. Click Create token.
    5. Copy the token and store it somewhere safe. scanr shows it once. Click I've saved my token.

    Tokens start with scanr_. Make one token per app or assistant, so you can see each one's usage and revoke one without breaking the others. Your tokens are listed under Your tokens, each with its permission, Read or Read & write, and its limits. To change a token's name or permission, click the pencil next to it. API Usage shows how many requests and AI credits you've used.

    Personal data access decides whether your tokens can read and change your saved scans, favorites, presets and scan history. Turn off Allow API tokens to access personal data to keep tokens to market data only.

    Your token is a password

    Anyone with the token can use your API plan. Don't paste it into a shared document or commit it to a code repository. If a token leaks, revoke it under Your tokens and create a new one.

    Connect an AI assistant

    The MCP server lives at https://mcp.scanr.ai. Your assistant connects in one of two ways:

    • Sign in with OAuth. Add https://mcp.scanr.ai as a custom connector in claude.ai or ChatGPT, or add it to Claude Code or Cursor without a token. The assistant opens scanr.ai in your browser. Check the app name and where it sends you back to, pick Read or Read & write, then slide to allow. The assistant gets its own token, which lasts 30 days.
    • Paste a token into the assistant's settings, sent in an Authorization: Bearer header.

    Once connected, it can build a scan from a plain-English request, run it, search for securities, read market status and news, and look up a stock's Weinstein stage history.

    The quickest way to set it up: paste this into an agent that can read a web page, such as Claude Code, Cursor or Codex. It walks you through the token, connects the server and runs a first scan.

    text
    Read https://api-docs.scanr.ai/connect.md and follow the instructions to connect me to scanr.ai.

    The MCP Server guide has the setup for Claude Code, Claude Desktop, Cursor, VS Code and Codex.

    Disconnect an assistant

    A token an assistant got through OAuth is listed under Your tokens with the assistant's name followed by (OAuth). Revoke it to disconnect the assistant. When the token expires after 30 days, the assistant asks you to approve it again. Its permission is the one you picked when you approved it, and you can't change it under Your tokens. To change it, reconnect the assistant and pick again.

    Where to go next

    You want toRead
    Make your first API callQuick Start
    Send your token the right wayAuthentication
    Turn a scan from the app into an API payloadBuilding Scan Payloads
    See what each API tier allowsPlans & Rate Limits
    Build a scanning agentBuild a Scanning Agent

    Troubleshooting

    IssueCauseSolution
    The API Tokens page says "API access not available"Your account has no API add-on.Click Upgrade to enable API access and add one.
    My token stopped workingThe API add-on lapsed, or the token was revoked.Renew the add-on under Plans and Upgrades, or create a new token.
    I lost my tokenscanr shows a token only once.Revoke the old token and create a new one.
    My assistant can't connect to the MCP serverIt sends the token in the wrong header, or your account has no API add-on.Send Authorization: Bearer <token>, or connect with OAuth instead. See the MCP Server guide.
    The approval page says "You need an API plan"Assistants connect through the API, which needs an API add-on.Add API access under Plans and Upgrades, then connect again.

    Was this page helpful?

    Still stuck?

    Ask scanr AI in the AI Terminal. It answers from this page. Included with Super and Super Pro.