canonical: https://jentic.com/apis/aletheiaapi.com/aletheiaapi # Aletheiaapi Aletheia Financial API This page describes a curated, agent-optimized Jentic OpenAPI specification for the Aletheia Financial API, kept validated and agent-ready. Aletheia also authors its own Swagger definition, published as a certified Microsoft Power Platform connector, which describes a wider set of SEC filing and earnings-call operations but omits the consumption and version reads covered here. Aletheia provides real-time stock market and cryptocurrency data through a small, focused REST surface. The API exposes a stock data endpoint, a crypto quote endpoint, an account consumption endpoint for tracking quota usage, and a version probe. Authentication uses an API key passed in the 'key' header on every request. ## For AI agents Look up real-time stock data and crypto quotes, and check API consumption from a focused four-endpoint financial data API. ## Scope Does not handle order placement, brokerage account access, or historical market data - use for real-time stock and crypto quote lookups only. ## Capabilities - Retrieve real-time stock data for a given ticker symbol with /StockData - Fetch a current crypto quote for a symbol via /Crypto - Check current API consumption against the account quota with /v2/consumption - Probe the API version with /version for environment health checks - Embed market data into agent workflows without parsing ticker websites ## Use cases ### Real-time stock watchlist for an internal tool An ops team builds an internal page that shows live prices for a list of tracked tickers by calling /StockData for each symbol on a short refresh interval. The minimal surface area means the integration is low-effort: a single GET with the ticker as a parameter and an API key header is enough to render a watchlist. Example prompt: GET /StockData for each ticker in the watchlist and render the resulting price and change values in the dashboard ### Crypto quote lookup before a trade alert A trading assistant agent receives a 'check BTC price' message and calls GET /Crypto with the BTC symbol to fetch the latest quote, then formats and posts the result to the user. Because the endpoint is read-only, the agent never needs trading credentials - only a market data API key. Example prompt: GET /Crypto with symbol=BTC and post the formatted price and 24h change back to the user channel ### API quota awareness for batch jobs A back-office batch job runs through hundreds of tickers nightly. Before the run, it calls GET /v2/consumption to confirm there is enough quota left in the period; if not, it pages an operator instead of silently failing partway through. This keeps batch reliability high without a separate quota tracker. Example prompt: GET /v2/consumption before starting the batch and abort if remaining quota is below the projected request count ### Agent-driven price lookup through Jentic A Jentic agent answers questions like 'what's the price of NVDA right now?' by calling /StockData with the ticker and returning the latest price. Because Aletheia is small and focused, the agent does not have to choose between dozens of operations - Jentic surfaces the single matching endpoint. Example prompt: Search Jentic for 'real-time stock price for a ticker', execute GET /StockData with the requested symbol, and return the price field ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /StockData | Retrieve real-time stock data | | GET | /Crypto | Retrieve a real-time crypto quote | | GET | /v2/consumption | Check current API consumption | | GET | /version | Get the API version | ## Key resources - **StockData** — Real-time stock data lookup for a ticker symbol - **Crypto** — Real-time crypto quote lookup for a symbol - **v2 Consumption** — Current account consumption against the API quota - **Version** — API version probe for environment checks ## Why Jentic - **Setup:** Wiring the Aletheia Financial API by hand means placing its API key on each request to api.aletheiaapi.com and handling the quote and consumption reads yourself. Through Jentic you install once, import the Aletheia Financial API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** The Aletheia Financial API is read-only quote lookup and carries its target as a query parameter, not a path resource, so limit the agent to the operations it needs, such as fetching stock data or crypto quotes. You choose the operations it may call, so the consumption or version reads are not included unless you add them. - **Credential handling:** Your Aletheia API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get a real-time stock quote' or 'look up a crypto price', and Jentic returns the matching Aletheia operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **CoinGecko API** — Use CoinGecko for broader crypto market data including historical series and market caps - **Alpha Vantage API** — Use Alpha Vantage for broader stock and FX market data including indicators and historical series - **OpenAI API** — Pair with Aletheia when an agent needs to summarise market data into a written report ## FAQ ### Which OpenAPI specification does this Aletheia Financial API page describe? A curated, agent-optimized Jentic specification covering four Aletheia operations, validated against the live API. Aletheia also authors its own Swagger 2.0 definition, published as a certified Microsoft Power Platform connector in Microsoft's connector reference repo at `https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Aletheia/apiDefinition.swagger.json`, which describes 20 operations across SEC filings, insider trades and earnings calls but omits the consumption and version reads this page covers. Jentic maintains the narrower OpenAPI 3.0.3 variant so agents match the real-time quote and quota operations without loading the full filings surface. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Aletheia Financial API use? Aletheia uses an API key passed in the 'key' header on every request. Jentic stores the key encrypted in its credential vault and injects it as the header at execution time, so the raw key never enters the agent's prompt context. ### Can I get a real-time stock price with the Aletheia API? Yes. Call GET /StockData with the ticker symbol as a query parameter and the 'key' header. The endpoint returns the latest price along with related stock data fields. ### What are the rate limits for the Aletheia Financial API? The OpenAPI spec does not declare per-endpoint rate limits. Aletheia enforces a quota per billing period; call GET /v2/consumption to check remaining quota before kicking off batch lookups. ### How do I look up a crypto quote through Jentic? Search Jentic for 'aletheia crypto quote', load the schema for GET /Crypto, and execute it with the symbol you want. Jentic returns the quote payload directly to the agent without exposing the API key. ### Does Aletheia provide historical price data? The endpoints exposed in this spec are real-time only - /StockData and /Crypto return current values. For historical price series, pair Aletheia with a complementary historical market-data provider. ### Can I limit what my agent is allowed to do with the Aletheia Financial API? Yes. Jentic One runs self-hosted on your own infrastructure, so your rules decide which Aletheia operations and credentials the agent can use. Because the Aletheia Financial API is read-only quote lookup and passes its target as a query parameter rather than a path resource, you can restrict the agent to just the calls it needs, such as GET /StockData for stock prices or GET /Crypto for crypto quotes. You choose the operations it may call, so the /v2/consumption and /version reads stay off limits unless you add them.