finterm bundle run ticker_data AAPL

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "run_id": "<string>",
    "bundle_name": "<string>",
    "descriptor_id": "<string>",
    "normalized_request": {},
    "submitted_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>",
    "updated_at": "<string>",
    "result": {},
    "error": {},
    "runtime_acknowledged": true,
    "manifest_ready": true,
    "links": {}
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

Bundle Tools

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.

POST

api

bundles

ticker_data

runs

finterm bundle run ticker_data AAPL

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "run_id": "<string>",
    "bundle_name": "<string>",
    "descriptor_id": "<string>",
    "normalized_request": {},
    "submitted_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>",
    "updated_at": "<string>",
    "result": {},
    "error": {},
    "runtime_acknowledged": true,
    "manifest_ready": true,
    "links": {}
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "upgrade_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A live account API key from FINTERM_API_KEY.

Body

application/json

ticker

string

Stock ticker symbol

Minimum string length: 1

company_name

string

Company name

Minimum string length: 1

mode

enum<string>

Requested execution mode

Available options:

placeholder,

live

delivery_mode

enum<string>

Requested result delivery mode

Available options:

inline_result,

artifact_metadata,

summary_json,

dataroom_sync

parameters

object

Additional bundle parameters

Show child attributes

Response

Run accepted.

The two-key success envelope.

finterm

object

required

Canonical result meta header.

Show child attributes

data

object

required

The asynchronous bundle run state returned when a bundle run is accepted.

Show child attributes

A live 0-100 sentiment composite for a ticker: seven components scored vs the ticker's own year, grouped trend / flow / positioning.Get bundle run status

Point Tools

Bundle Tools

Account

Feedback

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.

Authorizations

Body

Response