API QuantAPI Developer
A security goes on a Reg SHO threshold list when fails to deliver in it stay large (at least 10,000 shares and 0.5% of shares outstanding) for five consecutive settlement days. US venues publish their lists every trading evening. A long stay on the list signals persistent settlement stress, and after 13 consecutive settlement days Reg SHO requires brokers to close out the fails.
This API returns data for multiple stocks — every constituent of a market index, or of one of your own universes — for the specified date.
A snapshot reports the latest list dated on or before the requested date (today if omitted), and every row's date says which list that is.
Consecutive days counts the list dates in a row, up to and including this one, that the listing was on the list, including days before your window. It is zero when the listing is off the list.
US listings only: an index or universe that mixes US and non-US listings returns its US listings, and one with no US listings is rejected with a message saying so.
Available Data Points:
- Date: The list date reported. (
YYYY-MM-DDformat). - 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.
- Published Date: The date the list was published: the evening of the list date.
- On Threshold List: Whether the listing was on a Reg SHO threshold list that day.
- Consecutive Days On List: Consecutive list dates on the list, up to and including this one; 0 when off.
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
