FinanceSec API Reference

Loading API description...

Production Servers

Authentication

All FinanceSec endpoints require subscription authentication using a License Key header. Ensure this header is present in all outgoing API requests:

X-License-Key: <YOUR_LICENSE_KEY>

Failed authentication requests will result in an HTTP 402 License Required or 401 Unauthorized response payload. Manage your license keys in the API Keys Console.

Low-Token Compact Mode (v0.3.9)

For LLM agents and high-QPS integrations, pass "low_tokens": true on POST /api/query or MCP tool calls. Verbose JSON remains the default for dashboards and human workflows.

Compact mode is a serializer only — it never changes the recalled fact. On success you receive short field names (st, val, concept, per, truncated hash). Typical savings: ~88% vs verbose (~38 vs ~320 tokens per fact).

{
  "query": "What was Apple total revenue in FY2023?",
  "low_tokens": true
}

See also FinanceSec MCP install guide for tool-level usage.

Enterprise Latency Tiers (v0.3.9)

Warm-path empirical benchmarks (production-class arm64 host). Cold starts and deploy windows excluded.

Tier 1 — Direct Go engine: materialized bulk reader · p95 ≈ 0.13 µs
Tier 2 — Compact MCP / API: low_tokens=true · p95 ≈ 0.022 ms (gate < 50 ms)
Tier 3 — Conversational NLQ: full natural-language query path · p95 ≈ 0.53 ms (gate < 2.0 s)