Conventions

Request shape

Every endpoint takes a POST with a JSON body. The conventions described on this page apply uniformly across every endpoint.

POST /v1/options/tool/gainers-losers HTTP/1.1
Host: api.quantdata.us
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

{
  "sessionDate": "2026-05-13",
  "filter": {
    "ticker": "AAPL"
  }
}

The body is a single JSON object. For tools like Gainers / Losers above, every field is optional and an empty {} returns data for the latest session. Other tools require specific filters (Exposure By Strike, for example, requires a ticker). Top-level fields fall into three rough buckets: when (sessionDate, timeRange), what to include (filter, filterExpression), and how to slice the result. The slice fields vary by tool: aggregationPeriod on time-series tools, and includes, excludes, size, sort on the table-shaped tools.

Field names

Field references inside filterExpression, sort.field, and the includes / excludes arrays are matched case-, separator-, and whitespace-insensitively.

{
  "filterExpression": {
    "field": "STRIKE_PRICE",
    "operation": "=",
    "value": "150"
  }
}

// All four of these resolve to the same field:
//   "STRIKE_PRICE", "strikePrice", "strike-price", "Strike Price"

The convenience filter object is different: it uses standard camelCase JSON property names (e.g. tickers, expirationDate), and only those exact names are accepted. Enum values keep the canonical UPPER_SNAKE_CASE form on both the request and the response.

Many fields also have shorthand aliases beyond the canonical name: STRIKE resolves to STRIKE_PRICE, IV to IMPLIED_VOLATILITY, OI to OPEN_INTEREST. See Field Reference for the per-endpoint inventory.

Plural and singular

Collection-typed fields accept either the singular or the plural name, with either a scalar or an array value.

// All four shapes resolve to the same single-element collection.
{ "ticker": "AAPL" }
{ "ticker": ["AAPL"] }
{ "tickers": "AAPL" }
{ "tickers": ["AAPL"] }

// And a real multi-value request:
{ "tickers": ["AAPL", "NVDA", "TSLA"] }

The same convention applies to expirationDates, strikePrices, contractTypes, sectors, industries, and every other plural-named field. If you send both the plural and the singular alias in the same JSON object, the last one in source order wins.

Operation aliases

Filter operations accept symbolic, abbreviated, and full-name forms.

// The six comparisons each accept symbolic, abbreviated, and full-name forms.
//   =    ==    EQ     EQUAL              → EQUALS
//   !=   <>    NEQ    NOT_EQUAL          → DOES_NOT_EQUAL
//   <          LT     LESS               → LESS_THAN
//   <=         LTE    LE                 → LESS_THAN_OR_EQUAL_TO
//   >          GT     GREATER            → GREATER_THAN
//   >=         GTE    GE                 → GREATER_THAN_OR_EQUAL_TO

// These three filters do the same thing:
{ "field": "STRIKE_PRICE", "operation": "=", "value": "150" }
{ "field": "STRIKE_PRICE", "operation": "EQ", "value": "150" }
{ "field": "STRIKE_PRICE", "operation": "EQUALS", "value": "150" }

Defaults

Most inputs have a useful default, chosen so the simplest possible request still returns useful data. Override any one without having to set the others.

Units and formats

Requests use ISO date and instant strings for time. Responses use epoch milliseconds. Monetary values are dollars on both the request and the response.

Where to go next