Skip to main content
POST
/
api
/
v1
/
sec
/
diff
Summarize changed risk factors between two annual filings.
finterm tool sec_filing_diff AAPL --base 2023:FY --compare 2024:FY --sections risk_factors --mode summary
{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "ticker": "<string>",
    "base": {
      "year": 0,
      "period": "<string>",
      "form_type": "<string>",
      "filed_at": "<string>",
      "period_of_report": "<string>"
    },
    "compare": {
      "year": 0,
      "period": "<string>",
      "form_type": "<string>",
      "filed_at": "<string>",
      "period_of_report": "<string>"
    },
    "manifest": [
      {
        "section": "<string>",
        "added": 0,
        "removed": 0,
        "churn_pct": 123,
        "note": "<string>"
      }
    ],
    "report": "<string>"
  }
}

Authorizations

Authorization
string
header
required

A live account API key from FINTERM_API_KEY.

Body

application/json
ticker
string
required

Stock ticker symbol

base
object
required

Baseline filing

compare
object
required

Comparison filing

sections
string

Comma-separated section names

mode
enum<string>

Output mode

Available options:
diff,
raw,
summary
qa
boolean

Run the QA fidelity review

Response

Success.

The two-key success envelope.

finterm
object
required

Canonical result meta header.

data
object
required