Put/Call Ratio Timeseries

API QuantAPI DeveloperRequires options add-on

Daily put/call ratios for a group of stocks on a single date.

This API returns data for multiple stocks — every constituent of a market index, or of one of your own universes — for the specified date.

One row is returned per optionable US-listed stock in the selection, carrying its identifiers alongside its most recent reading on or before the requested date (today when date is omitted), looking back at most ten days; the row's date is that reading's date. Coverage is US-listed options only: a selection with no US listings is a 400 invalidSelection, and constituents with no listed options in the lookback do not appear.

Available Data Points:

  • Date: The specific date for which the data is retrieved (YYYY-MM-DD format).
  • Exchange Symbol: Symbol of the exchange where the security trades.
  • Ticker: The ticker symbol associated with the security.
  • Company Name: The name of the company issuing the security.
  • Ortex Company ID: Unique id for a company.
  • Ortex Security ID: Unique id for a security issued by a company.
  • Ortex Tradable Item ID: Unique id for a listing of a security.
  • PCR: Put/call ratio for the date, calculated from open interest.
  • PCR Volume: Put/call ratio for the date, calculated from traded volume.

Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.

Trial key restrictions: Trial keys may be limited to a specific date range and set of regions. Requests outside the allowed regions or entirely outside the allowed date range are rejected; a date window that partially overlaps the allowed range is trimmed to it, reported in meta.restriction.

Get full access! Get a key at app.ortex.com/apis

Query Params
string

The ORTEX index identifier used by this endpoint. Return one row per constituent of this market index, as of the requested date. Pick one from the examples, or type another ORTEX index identifier — the list covers the identifiers published today and is not exhaustive. Matching ignores case, so us500 and US500 are the same index. Supply exactly one of 'index' or 'universe' — sending both, or neither, returns 400 invalidSelection. An unrecognized index identifier returns 404 indexNotFound.

string

Return one row per constituent of one of your own universes, matched case-insensitively by name. Supply exactly one of 'index' or 'universe' — sending both, or neither, returns 400 invalidSelection. A name you do not own, or that does not exist, returns 404 universeNotFound. On a Quant key, a universe holding more than 250 constituents returns 409 universeSizeExceeded; nothing in it is changed. Manage your universes at /api/v11/universes/.

date

The single date to return data for (defaults to the latest available). Format: YYYY-MM-DD.

integer

Page number within the paginated result set. Must be >= 1. Defaults to 1.

integer

Number of rows per page. The default and the maximum allowed depend on the API tier; a value above the tier maximum is rejected with 400 invalidPageSize.

string
enum
Defaults to json

Response format. "json" (default) or "csv".

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv