Skip to main content
POST
/
api
/
v1
/
ticker-sentiment
Live sentiment composite for one symbol.
finterm tool ticker_sentiment AAPL
{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "ticker": "<string>",
    "as_of_date": "<string>",
    "price": 123,
    "score": 123,
    "coverage": "<string>",
    "sub_scores": {
      "trend": 123,
      "flow": 123,
      "positioning": 123
    },
    "components": [
      {
        "id": "<string>",
        "raw": 123,
        "percentile": 123,
        "score": 123,
        "window": "<string>",
        "note": "<string>"
      }
    ],
    "omitted": [
      {
        "component": "<string>"
      }
    ],
    "delta": {
      "d1": 123,
      "d5": 123,
      "d20": 123
    },
    "history": [
      {
        "date": "<string>",
        "score": 123,
        "coverage": "<string>"
      }
    ],
    "flags": [
      "<string>"
    ],
    "context": {
      "next_earnings": {
        "date": "<string>",
        "days": 123,
        "confirmed": true
      }
    },
    "derived": [
      "<string>"
    ],
    "scope": {
      "contracts_analyzed": 123,
      "expirations_covered": 123,
      "pages_fetched": 123
    },
    "data_quality": {
      "history": {
        "days_collected": 123
      },
      "note": "<string>"
    },
    "methodology": {
      "version": "<string>",
      "component_scoring": "<string>",
      "composite": "<string>",
      "band_cutoffs": [
        123
      ],
      "orientation": "<string>",
      "flow_sharing": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

A live account API key from FINTERM_API_KEY.

Body

application/json
ticker
string
required

Stock ticker symbol

as_of_date
string

As-of date: 'today' or YYYY-MM-DD

Response

Success.

The two-key success envelope.

finterm
object
required

Canonical result meta header.

data
object
required