latestOpenAPI 3.0.32026-08-101461131.1 MB

ad6f143e43aa

reference

Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date.

get/stocks/v1/short-interest

Query parameters

tickerstring

The primary ticker symbol for the stock.

ticker.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

ticker.gtstring

Filter greater than the value.

ticker.gtestring

Filter greater than or equal to the value.

ticker.ltstring

Filter less than the value.

ticker.ltestring

Filter less than or equal to the value.

days_to_covernumber double

Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number.

days_to_cover.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number.

days_to_cover.gtnumber double

Filter greater than the value. Value must be a floating point number.

days_to_cover.gtenumber double

Filter greater than or equal to the value. Value must be a floating point number.

days_to_cover.ltnumber double

Filter less than the value. Value must be a floating point number.

days_to_cover.ltenumber double

Filter less than or equal to the value. Value must be a floating point number.

settlement_datestring

The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules.

settlement_date.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

settlement_date.gtstring

Filter greater than the value.

settlement_date.gtestring

Filter greater than or equal to the value.

settlement_date.ltstring

Filter less than the value.

settlement_date.ltestring

Filter less than or equal to the value.

avg_daily_volumeinteger

The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer.

avg_daily_volume.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.

avg_daily_volume.gtinteger

Filter greater than the value. Value must be an integer.

avg_daily_volume.gteinteger

Filter greater than or equal to the value. Value must be an integer.

avg_daily_volume.ltinteger

Filter less than the value. Value must be an integer.

avg_daily_volume.lteinteger

Filter less than or equal to the value. Value must be an integer.

limitinteger

Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'.

sortstring

A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.

Response

A list of results.

next_urlstring

If present, this value can be used to fetch the next page.

request_idstring required

A request id assigned by the server.

status'OK' required

The status of this request's response.