Data API Endpoints

A Data API Endpoint handles a Data API Request and relays the Data API Response.

ORATS Data API.

Primary features include

• historical options data

• historical volatilities

• greeks

• bid/ask quotes

• 100+ indicators

See the product page and API docs.

class orats.endpoints.data.endpoints.DataApiEndpoint(token=None, mock=False)

An endpoint handles a request and relays the response.

__init__(token=None, mock=False)

Initializes an API endpoint for a specified resource.

Parameters

token (Optional[str]) – The authentication token provided to the user.

__call__(request)

Handles a request and relays the response.

Parameters

request (TypeVar(Req, bound= DataApiRequest)) – Data API request object.

Return type

Sequence[TypeVar(Res, bound= DataApiConstruct)]

Returns

One or more Data API response objects.

class orats.endpoints.data.endpoints.TickersEndpoint(token=None, mock=False)

Retrieves the duration of available data for various assets.

If no underlying asset is specified, the result will be a list of all available ticker symbols. Each symbol is accompanied by a start (min) and end (max) date for which data is available. See the corresponding Tickers endpoint.

class orats.endpoints.data.endpoints.StrikesEndpoint(token=None, mock=False)

Retrieves strikes data for the given asset(s).

See the corresponding Strikes and Strikes History endpoints.

class orats.endpoints.data.endpoints.StrikesByOptionsEndpoint(token=None, mock=False)

Retrieves strikes data by ticker, expiry, and strike.

See the corresponding Strikes by Options and Strikes History by Options endpoints.

__call__(*requests)

Makes a call to the appropriate API endpoint.

Passing a single request will use the GET request method, while passing a sequence will use the POST request method.

Parameters

requests (StrikesByOptionsRequest) – StrikesByOption request object.

Return type

Sequence[Strike]

Returns

A list of strikes for each specified asset.

class orats.endpoints.data.endpoints.MoniesImpliedEndpoint(token=None, mock=False)

Retrieves monthly implied data for monies.

See the corresponding Monies and Monies History endpoints.

class orats.endpoints.data.endpoints.MoniesForecastEndpoint(token=None, mock=False)

Retrieves monthly forecast data for monies.

See the corresponding Monies and Monies History endpoints.

class orats.endpoints.data.endpoints.SummariesEndpoint(token=None, mock=False)

Retrieves SMV Summary data.

See the corresponding Summaries and Summaries History endpoints.

class orats.endpoints.data.endpoints.CoreDataEndpoint(token=None, mock=False)

Retrieves Core data.

See the corresponding Core Data and Core Data History endpoints.

class orats.endpoints.data.endpoints.DailyPriceEndpoint(token=None, mock=False)

Retrieves end of day daily stock price data.

See the corresponding Daily Price endpoint.

class orats.endpoints.data.endpoints.HistoricalVolatilityEndpoint(token=None, mock=False)

Retrieves historical volatility data.

See the corresponding Historical Volatility endpoint.

class orats.endpoints.data.endpoints.DividendHistoryEndpoint(token=None, mock=False)

Retrieves dividend history data.

See the corresponding Dividend History endpoint.

class orats.endpoints.data.endpoints.EarningsHistoryEndpoint(token=None, mock=False)

Retrieves earnings history data.

See the corresponding Earnings History endpoint.

class orats.endpoints.data.endpoints.StockSplitHistoryEndpoint(token=None, mock=False)

Retrieves stock split history data.

See the corresponding Stock Split History endpoint.

class orats.endpoints.data.endpoints.IvRankEndpoint(token=None, mock=False)

Retrieves IV rank data.

See the corresponding IV Rank and IV Rank History endpoints.