Availability history

API Enterprise

Short-availability timeseries for a single instrument, served from the same daily dataset as the enterprise bulk endpoint — a timeseries row is identical to the bulk row for the same listing and date, so the two access patterns can be mixed freely.

Built for enterprise consumers: the response is uncharged (no credits). Instrument identity is stated once in the envelope's instrument block; data rows carry only the date and the measures.

Available Data Points:

  • Date: The specific date for which the data is retrieved (YYYY-MM-DD format).
  • Split Ratio: Cumulative split ratio applied to adjust share counts to today's terms.
  • Short Availability Percentage: The availability shares expressed as a percentage of total estimated short interest, indicating potential borrow supply relative to demand.
  • Short Availability Shares: An estimate of how many shares are currently available to borrow for shorting.

Date window and instrument identity

from_date and to_date are required and set the inclusive window. The instrument that owned the ticker at from_date is the one the whole response describes — a reused ticker never mixes securities or companies within one response, and the envelope's instrument block identifies exactly which listing the rows belong to. split_adjusted=false returns as-was share counts instead of values adjusted to today's terms.

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! Contact [email protected]

Path Params
string
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)

string
required

Ticker symbol

Query Params
string
enum
Defaults to json

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

Allowed:
date
required

Inclusive start of the returned date window. Required — a missing value returns 400 invalidDateRange. Also anchors instrument resolution: the instrument that owned the ticker at this date is the one the whole response describes. 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; values above the tier maximum are clamped down to it.

boolean
Defaults to true

Whether share counts are adjusted to today's terms (default) or returned as-was on the data date. Pass false for unadjusted (as-was) values.

date
required

Inclusive end of the returned date window. Required — a missing value returns 400 invalidDateRange. Format: YYYY-MM-DD.

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