Skip to main content
POST
/
api
/
v1
/
options
/
sentiment
Options sentiment for one symbol on a specific date.
finterm tool options_sentiment AAPL --as-of-date 2024-01-15
{
  "finterm": {
    "schema": "<string>",
    "tool": "<string>",
    "args": {},
    "request_id": "<string>",
    "cursor": "<string>"
  },
  "data": {
    "ticker": "<string>",
    "as_of_date": "<string>",
    "sentiment": {
      "put_call_volume_ratio": 123,
      "total_call_volume": 123,
      "total_put_volume": 123,
      "avg_spread_percent": 123
    },
    "data_quality": {
      "contracts_analyzed": 123,
      "contracts_with_volume": 123,
      "total_volume": 123
    },
    "contracts": {
      "total_calls": 123,
      "total_puts": 123,
      "contracts_with_volume": 123,
      "expirations": [
        "<string>"
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

A live account API key from FINTERM_API_KEY.

Body

application/json
underlying_ticker
string
required

Underlying stock ticker symbol

date
string
required

Historical options sentiment date in YYYY-MM-DD format

include_spread_analysis
boolean

Include bid-ask spread analysis

expiration_filter
string

Expiration-date lower bound

max_contracts
number

Maximum contracts to analyze

Response

Success.

The two-key success envelope.

finterm
object
required

Canonical result meta header.

data
object
required