Sign in

v1

latestOpenAPI 3.0.32026-07-246185298.2 KB
Short Interest

Short Availability

Access detailed insights into share availability for short selling. This endpoint offers transparency into the estimated number of shares available to borrow and how that compares to current short interest levels, helping you gauge market supply dynamics.

Available Data Points:

  • Date: Date for the availability data. (YYYY-MM-DD format).
  • Availability Shares: The estimated number of shares available to borrow for short selling, based on market utilization and reported availability.
  • Availability Percentage of Short Interest: The availability shares expressed as a percentage of estimated short interest, indicating how much of the short demand could be covered by borrowable supply.

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: A list of randomly selected rows will be returned

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

get/api/v1/stock/{exchange_symbol}/{ticker}/availability

Path parameters

exchange_symbolstring required

Exchange symbol (e.g. "nyse", "nasdaq"), MIC code (e.g. "xnys", "xnas") or two character ISO country code (e.g "us", "ca" for ALL country exchanges)

tickerstring required

Ticker symbol

Query parameters

format'csv' | 'json'

Format of the response. Can be "json" or "csv". Default is "json".

from_datestring date

Starting date for short interest data (defaults to one month ago). Format: YYYY-MM-DD

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

ticker_as_of_datestring

US instruments only. Picks which instrument a ticker refers to, as of the given date (format yyyy-mm-dd).

What it does: changes instrument resolution only. It does not filter or move the returned data — that stays controlled by the endpoint's own data parameters (such as from_date / to_date, or as_of_date on the options endpoints). Think of it as answering "who owned this ticker on this date?", not "what data do I want back?".

Why you need it: tickers get reused, renamed and delisted over time (e.g. FB → META; SPLK was delisted when Cisco acquired Splunk). By default the endpoint matches the ticker on the exchange in the URL path to the currently-active instrument — so a ticker that no longer trades returns 404, and a recycled ticker resolves to today's owner, not the historical one.

When set: the URL path exchange is ignored and all US exchanges are searched for whichever instrument held the ticker on that date. This lets you pull history for a company that has since changed ticker, delisted, or moved exchange.

Rules:

  • Omitted → current behaviour, exactly unchanged.
  • Present (any value, even blank or a future date) → as-of resolution is applied; a blank value defaults to today.
  • A non-US exchange / MIC / country code combined with this parameter returns 400.

Note: on the options endpoints this is distinct from as_of_date, which filters the option data snapshot — ticker_as_of_date only selects the instrument.

to_datestring date

Ending date for short interest data (defaults to today). Format: YYYY-MM-DD

Headers

accept'*/*' required

Response

paginationLinksobject
lengthinteger required

Example response

{
  "paginationLinks": {
    "next": "http://api.example.org/accounts/?page=4",
    "previous": "http://api.example.org/accounts/?page=2"
  },
  "length": 123
}