> ## Documentation Index
> Fetch the complete documentation index at: https://docs.finterm.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ticker Data

> The full ticker snapshot: earnings, guidance, the price reaction window, ratios, options sentiment, short pressure, technicals, financial statements, and pre-earnings market context, in one call.

Get the complete data snapshot for a ticker in a single bundle run.
ticker\_data composes finterm’s individual data tools into one bundle anchored on a
company’s most recent earnings event, so you can read the whole picture without
stitching ten separate requests together.
Each section is self-contained and is present only when it has data; a section that
produced nothing comes back as null.

The bundle returns:

* **earnings:** the reported quarter’s actuals, estimates, and surprise for both EPS and
  revenue, with the fiscal quarter.
* **guidance:** forward guidance for the period being analyzed: the revenue and EPS
  ranges (min / max / mid, plus the prior range and whether the guide was revised).
* **prices:** the event-study price window around the earnings close: the prior trading
  day, the event close, and the closes one and five trading days later.
* **ratios:** trailing-twelve-month margins, return on equity, and the P/E ratio.
* **options:** put/call sentiment with its interpretation, call and put volume, the
  average spread, a liquidity grade, and a data-quality verdict so a thin sample is
  never mistaken for a confident reading.
* **short:** short interest (shares short, days to cover) and recent short-volume
  pressure.
* **technical\_indicators:** the default set: RSI(14), MACD(12/26/9), and the 20- and
  50-period simple moving averages.
* **financial\_statements:** a key-metric snapshot by default, or the full income
  statement, balance sheet, and cash flow on request.
* **pre\_earnings\_context:** the stock’s run-up into the event, where its price sits in
  its 52-week range, a volatility proxy, and the index versus its 200-day average.

Each external CLI invocation creates a bundle run for one ticker; create another run for
another ticker.

**Endpoint:** `POST /api/v1/bundles/ticker_data/runs`

**Tier:** bundle · **Delivery:** sync

## Request

| Field           | Type                                                                          |
| --------------- | ----------------------------------------------------------------------------- |
| `ticker`        | `string`                                                                      |
| `company_name`  | `string`                                                                      |
| `mode`          | `"placeholder" \| "live"`                                                     |
| `delivery_mode` | `"inline_result" \| "artifact_metadata" \| "summary_json" \| "dataroom_sync"` |
| `parameters`    | `record\<string, unknown>`                                                    |

## Response

The response is the two-key envelope `{ finterm, data }`, where `data` is the `finterm.result:TickerDataBundle/v1` contract:

| Field                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ticker`               | The stock ticker symbol, uppercased (e.g. "AAPL").                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `earnings_date`        | The reported earnings date this snapshot is anchored on, in YYYY-MM-DD format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `earnings`             | The reported quarter’s earnings: eps\_actual, eps\_estimate, eps\_surprise\_pct, revenue\_actual, revenue\_estimate, revenue\_surprise\_pct, fiscal\_quarter, and reported\_at. A figure is null when not reported. Null when the section produced no data.                                                                                                                                                                                                                                                                                                                                                    |
| `guidance`             | Forward guidance for the fiscal period being analyzed: the fiscal\_period, guidance\_date, revenue range (revenue\_min, revenue\_max, revenue\_mid, plus the prior revenue\_prev\_min / revenue\_prev\_max and the revenue\_method), the eps range (eps\_min, eps\_max, eps\_mid), and guidance\_revised (whether the range changed from the prior guide). Note: revenue\_mid is analyst consensus, which can fall outside the company range. Null when no guidance was found.                                                                                                                                 |
| `prices`               | Event-study price window around the earnings close: t\_minus\_1 (the prior trading day), t0 (the event close), t\_plus\_1, and t\_plus\_5. Each is \{ date, close } in USD, or null when that day is not yet available. Null when no prices were resolved.                                                                                                                                                                                                                                                                                                                                                     |
| `ratios`               | Trailing-twelve-month ratios: gross\_margin\_pct, operating\_margin\_pct, net\_margin\_pct, return\_on\_equity\_pct, revenue\_growth\_yoy\_pct, and pe\_ratio. A value is null when not computable. Null when the section produced no data.                                                                                                                                                                                                                                                                                                                                                                    |
| `options`              | Options-market sentiment: put\_call\_volume\_ratio and its fixed convention label (below 0.7 bullish, 0.7–1.0 neutral, above 1.0 bearish), total\_call\_volume, total\_put\_volume, avg\_spread\_percent, liquidity\_grade (A best to D worst), contracts\_with\_volume, the list of expirations covered, and a data\_quality verdict (status "ok" / "no\_data" / "thin\_sample" with the contract and volume counts) so a thin reading is never mistaken for a confident one. The thresholds are descriptive, not calibrated forecasts for a symbol or market regime. Null when the section produced no data. |
| `short`                | Short pressure: shares\_short, short\_float\_pct, days\_to\_cover, and interest\_as\_of\_date from the latest short-interest reading, plus avg\_short\_volume\_ratio\_pct, max\_short\_volume\_ratio\_pct, and days\_above\_40\_pct from the recent short-volume window. A value is null when unavailable. Null when the section produced no data.                                                                                                                                                                                                                                                             |
| `technical_indicators` | The default indicator set: rsi\_14 (conventional above-70 overbought and below-30 oversold heuristic labels, not reversal forecasts), macd\_value, macd\_signal, macd\_histogram (12/26/9 configuration), sma\_20, and sma\_50. A value is null when not computable. Null when the section produced no data.                                                                                                                                                                                                                                                                                                   |
| `financial_statements` | Reported financials as of as\_of\_period\_end. By default a "lite" key-metric snapshot (revenue, gross\_profit, operating\_income, net\_income, eps, eps\_diluted, cash\_from\_operations, free\_cash\_flow, total\_debt, cash\_and\_equivalents, total\_equity); on request a "verbose" block with the full income\_statement, balance\_sheet, and cash\_flow records. Null when no statements were found.                                                                                                                                                                                                    |
| `pre_earnings_context` | Market context heading into the event: run\_10d\_pct, run\_30d\_pct, run\_90d\_pct (the stock’s run-up over those windows), percentile\_52w (where the price sits in its 52-week range), vix\_proxy\_close and vix\_percentile (a volatility proxy and its percentile), sp500\_vs\_200dma\_pct (the index versus its 200-day average), and the bar counts behind each series (stock\_bars\_count, vix\_bars\_count, spy\_bars\_count). A value is null when not computable. Null when the section produced no data.                                                                                            |

## Example

```bash theme={"system"}
finterm bundle run ticker_data AAPL
```
