Data API Requests

pydantic model orats.endpoints.data.request.TickersRequest

Request duration of historical data for tickers.

Show JSON schema

{
   "title": "TickersRequest",
   "description": "Request duration of historical data for tickers.",
   "type": "object",
   "properties": {
      "ticker": {
         "title": "Ticker",
         "description": "The ticker symbol of the underlying asset.",
         "type": "string"
      }
   }
}

Fields

ticker (Optional[str])

field ticker: Optional[str] = None: The ticker symbol of the underlying asset.

pydantic model orats.endpoints.data.request.StrikesRequest

Retrieves strikes data for the given asset(s).

Show JSON schema

{
   "title": "StrikesRequest",
   "description": "Retrieves strikes data for the given asset(s).",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "dte": {
         "title": "Dte",
         "description": "Filters results to a range of days to expiration.Specified as a comma separated pair of integers.To ignore an upper/lower bound, leave the value blank.Examples: ``30,45``, ``30,`` == ``30``, ``,45``",
         "type": "string"
      },
      "delta": {
         "title": "Delta",
         "description": "Filters results to a range of delta values.Specified as a comma separated pair of floating point numbers.To ignore an upper/lower bound, leave the value blank.Examples: ``.30,.45``, ``.30,`` == ``.30``, ``,.45``",
         "type": "string"
      }
   }
}

Fields

delta_range (Optional[str])
expiration_range (Optional[str])

field delta_range: Optional[str] = None (alias 'delta'): Filters results to a range of delta values.Specified as a comma separated pair of floating point numbers.To ignore an upper/lower bound, leave the value blank.Examples: .30,.45, .30, == .30, ,.45

field expiration_range: Optional[str] = None (alias 'dte'): Filters results to a range of days to expiration.Specified as a comma separated pair of integers.To ignore an upper/lower bound, leave the value blank.Examples: 30,45, 30, == 30, ,45

pydantic model orats.endpoints.data.request.StrikesByOptionsRequest

Retrieves strikes data by ticker, expiry, and strike.

Show JSON schema

{
   "title": "StrikesByOptionsRequest",
   "description": "Retrieves strikes data by ticker, expiry, and strike.",
   "type": "object",
   "properties": {
      "ticker": {
         "title": "Ticker",
         "description": "The ticker symbol of the underlying asset.",
         "type": "string"
      },
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "expirDate": {
         "title": "Expirdate",
         "description": "The expiration date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "strike": {
         "title": "Strike",
         "description": "The strike price to retrieve.",
         "type": "number"
      }
   },
   "required": [
      "ticker",
      "expirDate",
      "strike"
   ]
}

Fields

expiration_date (datetime.date)
strike (float)
trade_date (Optional[datetime.date])

field expiration_date: date [Required] (alias 'expirDate'): The expiration date to retrieve.

field strike: float [Required]: The strike price to retrieve.

field trade_date: Optional[date] = None (alias 'tradeDate'): The trade date to retrieve.

pydantic model orats.endpoints.data.request.MoniesRequest

Retrieves end of day monthly implied/forecast history data for monies.

Show JSON schema

{
   "title": "MoniesRequest",
   "description": "Retrieves end of day monthly implied/forecast history data for monies.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields

pydantic model orats.endpoints.data.request.SummariesRequest

Retrieves SMV Summary data.

Show JSON schema

{
   "title": "SummariesRequest",
   "description": "Retrieves SMV Summary data.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields
Validators

pydantic model orats.endpoints.data.request.CoreDataRequest

Retrieves Core history data.

Show JSON schema

{
   "title": "CoreDataRequest",
   "description": "Retrieves Core history data.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields
Validators

pydantic model orats.endpoints.data.request.DailyPriceRequest

Retrieves end of day daily stock price data.

Show JSON schema

{
   "title": "DailyPriceRequest",
   "description": "Retrieves end of day daily stock price data.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields
Validators

pydantic model orats.endpoints.data.request.HistoricalVolatilityRequest

Retrieves historical volatility data.

Show JSON schema

{
   "title": "HistoricalVolatilityRequest",
   "description": "Retrieves historical volatility data.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields
Validators

pydantic model orats.endpoints.data.request.DividendHistoryRequest

Retrieves dividend history data.

Show JSON schema

{
   "title": "DividendHistoryRequest",
   "description": "Retrieves dividend history data.",
   "type": "object",
   "properties": {
      "ticker": {
         "title": "Ticker",
         "description": "The ticker symbol of the underlying asset.",
         "type": "string"
      }
   },
   "required": [
      "ticker"
   ]
}

Fields

pydantic model orats.endpoints.data.request.EarningsHistoryRequest

Retrieves earnings history data.

Show JSON schema

{
   "title": "EarningsHistoryRequest",
   "description": "Retrieves earnings history data.",
   "type": "object",
   "properties": {
      "ticker": {
         "title": "Ticker",
         "description": "The ticker symbol of the underlying asset.",
         "type": "string"
      }
   },
   "required": [
      "ticker"
   ]
}

Fields

pydantic model orats.endpoints.data.request.StockSplitHistoryRequest

Retrieves stock split history data.

Show JSON schema

{
   "title": "StockSplitHistoryRequest",
   "description": "Retrieves stock split history data.",
   "type": "object",
   "properties": {
      "ticker": {
         "title": "Ticker",
         "description": "The ticker symbol of the underlying asset.",
         "type": "string"
      }
   },
   "required": [
      "ticker"
   ]
}

Fields

pydantic model orats.endpoints.data.request.IvRankRequest

Retrieves IV rank data.

Show JSON schema

{
   "title": "IvRankRequest",
   "description": "Retrieves IV rank data.",
   "type": "object",
   "properties": {
      "tradeDate": {
         "title": "Tradedate",
         "description": "The trade date to retrieve.",
         "type": "string",
         "format": "date"
      },
      "fields": {
         "title": "Fields",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "ticker": {
         "title": "Ticker",
         "description": "List of assets to retrieve.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields
Validators