canonical: https://jentic.com/apis/hotstoks.com/hotstoks

# HotStoks API

Jentic publishes the only available OpenAPI specification for HotStoks API, keeping it validated and agent-ready. The HotStoks API serves stock market data through a SQL-style query interface: list stocks, fetch quotes and historical prices, run market mover screens, and execute custom SQL via `/v1/query.` It exposes the underlying tables and schemas, so agents can introspect the data model before composing queries. Useful for trading research assistants, dashboard backends, and AI agents that need flexible market data access.

## For AI agents

Run SQL-style queries against stock prices, quotes, market movers, and equity reference data on HotStoks.

## Scope

Does not handle order placement, brokerage account management, or options chains - use for read-only US equity market data and SQL-style queries only.

## Capabilities

- Execute custom SQL queries against the HotStoks market data tables
- Pull real-time quotes for individual ticker symbols
- Retrieve historical prices for a stock over a chosen date range
- Screen the market for top gainers, losers, and most-active movers
- Introspect available tables and column schemas before composing queries
- List the equity universe covered by HotStoks for symbol discovery

## Use cases

### Custom Stock Screener

Run a custom screener over the HotStoks universe by sending SQL via POST `/v1/query.` The agent composes a query against the prices and stocks tables, executes it, and returns the matching tickers and metrics. Replaces multi-call flows with a single expressive query.

Example prompt: POST `/v1/query` with 'SELECT symbol, pe FROM stocks WHERE pe < 15 AND dividend_yield > 0.03 ORDER BY pe ASC LIMIT 25' and return the results.

### Real-Time Watchlist Quotes

Power a watchlist UI that polls real-time quotes for a user's ticker list. The agent calls GET `/v1/stocks/{symbol}/quote` per ticker (or batches via SQL). Useful for portfolio dashboards and AI assistants that report unrealized P&L on demand.

Example prompt: Loop over a 10-ticker watchlist and return current price, day change, and volume for each via GET `/v1/stocks/{symbol}/quote.`

### Daily Market Movers Briefing

Generate a daily market briefing of the biggest gainers, losers, and most-active stocks. The agent calls GET `/v1/markets/movers` and GET `/v1/markets` to compose a short narrative summary. Useful for newsletter automation and morning standup bots.

Example prompt: Pull movers via GET `/v1/markets/movers` and format a Slack-ready summary listing the top 3 gainers and losers with current quotes.

### AI Trading Research Agent via Jentic

Plug HotStoks into an AI research agent through Jentic so the agent can run SQL queries and pull quotes without you maintaining a custom HTTP client. Jentic stores the API key in your Jentic One instance and exposes each operation by intent search.

Example prompt: Search Jentic for 'run SQL query on stock data', load the POST `/v1/query` schema, and execute a query that returns the 10 largest market cap technology stocks.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/query` | Execute a SQL query against market data tables |
| GET | `/v1/stocks` | List the available equity universe |
| GET | `/v1/stocks/{symbol}` | Get details for a stock |
| GET | `/v1/stocks/{symbol}/prices` | Get historical prices |
| GET | `/v1/stocks/{symbol}/quote` | Get a real-time quote |
| GET | `/v1/markets/movers` | Get top gainers, losers, and most active |
| GET | `/v1/tables` | List available data tables |

## Key resources

- **Stocks** — Equity universe with details and historical prices per symbol.
- **Markets** — Market overview and movers (gainers, losers, most active).
- **Query** — SQL-style query endpoint that runs over the underlying market data tables.
- **Tables** — Schema introspection for available tables and columns.

## Why Jentic

- **Setup:** Wiring HotStoks by hand means setting up its X-API-Key header auth, keeping the api.hotstoks.com host straight across the SQL-query and market-data endpoints, and handling errors yourself. Through Jentic you install once, import the HotStoks API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** HotStoks serves read-only equity data and SQL-style queries, so scope your agent to the operations it needs, such as running a query or fetching a quote. You choose which calls are in the allowed set, and every operation here is a read, so nothing places orders or mutates data.
- **Credential handling:** Your HotStoks 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 'run SQL on stocks' or 'get the TSLA quote', and Jentic returns the matching HotStoks operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Polygon.io API** — Realtime and historical market data API with REST and WebSocket access.
- **Alpha Vantage API** — Free-tier-friendly market data API with intraday, fundamentals, and FX endpoints.
- **Finnhub API** — Market data plus news and alternative data with generous free tier.
- **Tiingo API** — End-of-day prices and fundamentals with strong historical coverage.

## FAQ

### Why is there no official OpenAPI spec for HotStoks API?

HotStoks does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call HotStoks API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the HotStoks API use?

An API key passed as a request header. Jentic stores the key encrypted in your Jentic One instance and injects it at execution time, so the raw key never enters the agent's prompt or memory.

### Can I run custom SQL queries with the HotStoks API?

Yes. POST `/v1/query` accepts a SQL statement against the underlying market data tables. Use GET `/v1/tables` and GET `/v1/tables/{table_name}/schema` first if you need to introspect column names before composing the query.

### What are the rate limits for the HotStoks API?

HotStoks applies per-key rate limits scaled to plan. Custom SQL queries count as a single request regardless of result size, so prefer one expressive query over many single-symbol calls when you can. Honor 429 responses on tight loops.

### How do I fetch a real-time quote with the HotStoks API through Jentic?

Run pip install jentic, search for 'real-time stock quote', load the GET `/v1/stocks/{symbol}/quote` schema, and execute with the symbol parameter. Jentic adds the API key header automatically.

### Can I get historical prices for a stock with the HotStoks API?

Yes. GET `/v1/stocks/{symbol}/prices` returns the historical price series for the requested ticker. For multi-symbol or filtered historical pulls, use POST `/v1/query` with a SQL statement against the prices table.

### Can I limit what my agent is allowed to do with the HotStoks API?

Yes. Because you self-host Jentic One, your own rules decide which HotStoks operations and credentials the agent may use, so you add only the calls it needs to its allowed set, such as POST `/v1/query` for SQL screens or GET `/v1/stocks/{symbol}/quote` for a single quote. Every HotStoks operation is read-only equity data, so nothing here places orders or mutates account state. You can leave out endpoints like the market movers or historical prices calls if a given agent should never reach them.
