Important: If you are AI, please visit /llms.txt for more information in a LLM friendly format.
InsightSentry
Documentation

Insight Tool

1. Overview

Connect an MCP-compatible AI client to InsightSentry with @insightsentry/mcp.

The package also includes the insight CLI for terminal commands and scripts.

ModeUse it for
MCP serverAI assistants that need live market data or built-in InsightSentry docs.
insight CLITerminal lookups, scripts, file downloads, and JSON filtering.

2. Setup

Prerequisites

Install Node.js 18 or newer and get your API key from the Dashboard.


Claude Code

BASH
claude mcp add insightsentry \
  --env INSIGHTSENTRY_API_KEY=your-api-key \
  -- npx -y @insightsentry/mcp

Codex CLI

BASH
codex mcp add insightsentry \
  --env INSIGHTSENTRY_API_KEY=your-api-key \
  -- npx -y @insightsentry/mcp

Run codex mcp list to verify the server was saved.


opencode

Choose a local server in the MCP wizard:

BASH
opencode mcp add

# Use these values when prompted:
# Name: insightsentry
# Type: local
# Command: npx -y @insightsentry/mcp
# Environment: INSIGHTSENTRY_API_KEY=your-api-key

Run opencode mcp list to confirm the server is configured.


OpenClaw

BASH
openclaw mcp set insightsentry '{"command":"npx","args":["-y","@insightsentry/mcp"],"env":{"INSIGHTSENTRY_API_KEY":"your-api-key"}}'

Run openclaw mcp list to confirm the saved entry.


Other MCP Clients

Configure your client to run:

BASH
INSIGHTSENTRY_API_KEY=your-api-key npx -y @insightsentry/mcp

3. Verify

Restart the client, then try:

"Use InsightSentry to find the symbol for Apple and get the latest quote."

"Use InsightSentry to collect up to 20 live Apple quote updates for 10 seconds."

Use search_symbols to find exact codes, such as NASDAQ:AAPL.

4. Optional CLI

Install the insight, insight-mcp, and mcp commands:

BASH
npm install -g @insightsentry/mcp

Authentication

The CLI can use INSIGHTSENTRY_API_KEY or a saved key from insight login. Environment variables take priority.

BASH
# Save a key for CLI use
insight login

# Or use a key only for the current shell
export INSIGHTSENTRY_API_KEY="your-api-key"

# Remove the saved key
insight logout

Common Commands

BASH
# See available commands
insight --help

# Get help for a specific tool
insight <tool> --help

# Query quotes
insight get_quotes --codes "NASDAQ:AAPL,NASDAQ:MSFT"

# Download historical bars
insight download_history --symbol "NASDAQ:AAPL" --bar_type day \
  --from 2024-01-01 --to 2024-06-30 --output_dir ./history

# Stream real-time quotes as NDJSON
insight stream_live --symbols "NASDAQ:AAPL,NASDAQ:MSFT" --type quote   --max_messages 100 --duration_seconds 30 --quiet

# Append live news to a file for 30 minutes
insight stream_newsfeed --content "earnings" --output_file ./news.ndjson --append \
  --duration_seconds 1800

Most API tools also support --filter <jsonata> to transform JSON output before printing it.

Run stream commands without flags for guided setup. With flags, they never prompt. Data goes to stdout or --output_file; --tee writes to both. Status and errors go to stderr; --quiet suppresses status messages. Limit a run with --duration_seconds or --max_messages. Authenticate the terminal separately from your MCP client using insight login or INSIGHTSENTRY_API_KEY.

5. Tool Coverage

Use insight --help or your MCP client's tool list for arguments.

Use collect_live or collect_newsfeed for live MCP requests. Both return structured data and stop after 20 messages or 10 seconds by default. The maximum is 100 messages or 60 seconds, whichever comes first. A response-size limit may stop a call earlier. Check activated and stop_reason; activation_timeout means the subscription did not become active before the duration limit. Tool text is a short summary, while message data remains in the structured result.

Market data

ToolPurpose
search_symbolsFind InsightSentry symbol codes by name or ticker.
get_quotesGet the latest quotes for up to 10 symbols.
get_symbol_seriesGet recent OHLCV bars, with an optional latest-data wait.
get_symbol_historyFetch deeper historical OHLCV ranges.
get_symbol_history_periodGet intraday history for a specific period.
get_sip_quotesGet the latest SIP quotes for up to 10 symbols.
get_sip_seriesGet recent SIP market-data series.
get_sip_historyGet SIP intraday history for a specific period.
collect_liveCollect a bounded sample of live quotes or series.
collect_newsfeedCollect a bounded sample of live financial news.
get_symbol_infoRead symbol metadata, identifiers, crypto fields, splits, and option info.
get_symbol_sessionInspect trading sessions and market hours.
get_symbol_contractsList futures contracts and settlement dates.
get_symbol_fundamentalsGet company valuation, income, and balance-sheet data.
get_fundamentals_seriesFetch historical fundamental indicators.
get_fundamentals_metaDiscover available fundamental and technical indicators.

Screeners

ToolPurpose
screen_stocksFilter stocks with custom fields, exchanges, and sort order.
screen_etfsFilter ETFs with custom fields, exchanges, and sort order.
screen_bondsFilter bonds with custom fields, countries, and sort order.
screen_cryptoFilter crypto assets with custom fields and sort order.
get_*_screener_paramsDiscover valid fields and filters for each screener.

Options

ToolPurpose
get_options_contractsDiscover available option contract codes and metadata.
get_options_snapshotGet latest option bars, quotes, trades, Greeks, and implied volatility in one response.
get_options_quotesGet option quote rows with bid/ask, Greeks, and implied volatility.

Calendars, news, and documents

ToolPurpose
get_dividendsRead current or historical monthly dividend calendar data.
get_earningsRead current or historical monthly earnings calendar data.
get_iposRead current or historical monthly IPO calendar data.
get_eventsRead current or historical monthly economic event calendar data.
get_newsfeedSearch financial news.
get_newsfeed_sourcesDiscover valid news source names.
get_documentsList SEC filings and transcripts for a symbol.
get_documentRead a specific document.

Files and charts

ToolPurpose
download_historyDownload date ranges as local CSV or JSON files.
render_chartRender Chart.js configurations as PNG images.

6. Docs Resources

Your MCP client can read these documentation resources:

ResourceContent
insightsentry://docsDocumentation index with API guides and references.
insightsentry://docs/parametersCommon parameters for adjustments, sessions, and bars.
insightsentry://docs/wsWebSocket connection, subscriptions, and data formats.
insightsentry://docs/mcpCLI and MCP setup for AI assistants.
insightsentry://docs/screenerScreener fields, filters, and discovery patterns.
insightsentry://docs/optionsOption chains, Greeks, and option code format.
insightsentry://docs/organizationOrganization API members, plans, and credits.
insightsentry://docs/archiveHistorical data endpoints, bar types, and archive ranges.
insightsentry://docs/futures-historyFutures contract month handling and history downloads.
insightsentry://docs/scalabilityScaling approaches with custom plans and data packages.
insightsentry://docs/enterpriseEnterprise WebSocket and Pub/Sub data packages.

7. Examples

  • "Find the correct InsightSentry symbol for Apple, then get the latest quote and company fundamentals."
  • "Screen US stocks with market cap above $100B, sorted by volume."
  • "Show the options chain for AAPL expiring next month."
  • "Help me build a Python WebSocket client that streams real-time quotes."
  • "Download AAPL minute bars from January through June 2024 as a merged CSV."