Snapshot Tools

This document provides API documentation for the point-in-time financial snapshot tools.

get_point_in_time_snapshot(ticker: str, as_of: str) -> dict

Return an AI-friendly Markdown historical financial snapshot for a ticker as of a specific date.

Snapshot v0 costs 1 credit and requires API key authentication.

Parameters

• ticker (str): Stock ticker symbol.
• as_of (str): Historical snapshot date in YYYY-MM-DD format.

Snapshot Contents

• Market context: recent price action, performance metrics, technical indicators, and market interpretation ending at as_of.
• Company filings and financials available before as_of.
• Parsed filing excerpts and key historical business context.
• Historical news and discussion context when available.
• Metadata with status, warnings, and cache information.

Sample Response

{
  "ticker": "AAPL",
  "as_of": "2022-03-01",
  "format": "markdown",
  "data": "# AAPL Point-in-Time Financial Snapshot\n\n**As of:** 2022-03-01\n**Company:** Apple Inc.\n**CIK:** 0000320193\n\n## Market Context\nPeriod analyzed: ...",
  "metadata": {
    "warnings": [],
    "cache": {
      "status": "miss",
      "created_at": "...",
      "expires_at": null
    }
  }
}

Returns

• dict: A response object containing ticker, as_of, format, Markdown snapshot data, and metadata.

HTTP API: GET /snapshot

The same snapshot is available through the REST API.

Endpoint

GET https://mcp.plusefin.com/api/snapshot?ticker=AAPL&as_of=2022-03-01

Authentication

Pass the API key in the Authorization header.

curl -s -H "Authorization: Bearer YOUR_API_KEY" \
  "https://mcp.plusefin.com/api/snapshot?ticker=AAPL&as_of=2022-03-01"

Parameters

• ticker (str, required): Stock ticker symbol, for example AAPL.
• as_of (str, required): Historical snapshot date in YYYY-MM-DD format.

Cache Behavior

• Uses local SQLite snapshot cache by default.
• Historical snapshots where as_of is before today do not expire.
• Same-day snapshots expire after 1 hour.

Returns

• dict: A response object containing ticker, as_of, format, Markdown snapshot data, and metadata.