Guides

Introduction

Welcome to the scanr.ai API — a REST interface for the scanning, technicals, and market-data engine that powers scanr.ai. Use it to run scans programmatically, pull chart patterns and indicators, fetch fundamentals, and integrate scanr.ai data into your own tools and workflows.

What you can do

  • Run scans — execute saved scans or ad-hoc filter payloads across the full U.S. equities universe.
  • Read market data — bars (OHLCV), realtime/delayed prices, indices, dividends, earnings, IPOs, news, insider transactions.
  • Pull technicals — chart patterns, supply/demand zones, indicator series, feature windows, relative-volume distributions.
  • Reference companies — search securities, fetch detailed ticker metadata, peers, themes, and bubble-/tree-/sankey-chart datasets.
  • Plug into an AI assistant — the MCP Server exposes scans, fundamentals, news, and price data as tools for Claude, Cursor, and any other Model Context Protocol client.

The full list of REST endpoints is in the API Reference.

Base URL 

https://scanr.ai/api/v2

All endpoints are versioned under /api/v2. Responses are JSON; requests that accept a body expect Content-Type: application/json.

Authentication

Every API request must be authenticated with a token you generate from your account. See Authentication for how to create a token and sign requests.

Rate limits

Rate limits are applied per token and depend on your API subscription tier. Each token carries its own perMinute, perHour, and perDay ceilings, returned when the token is created and visible in your dashboard. Exceeding a limit returns 429 Too Many Requests.

Versioning & stability

The current version is v2. Breaking changes ship under a new version path; additive changes (new fields, new endpoints) can land on v2 without notice. Treat unknown response fields as forward-compatible.

Status & support

Next
Authentication

scanr.ai API (dev)