tickerstringOptional
The primary ticker symbol for the stock.
ticker.any_ofstringOptional
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
ticker.gtstringOptional
Search ticker for values that are greater than the given value.
ticker.gtestringOptional
Search ticker for values that are greater than or equal to the given value.
ticker.ltstringOptional
Search ticker for values that are less than the given value.
ticker.ltestringOptional
Search ticker for values that are less than or equal to the given value.
days_to_covernumberOptional
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.
days_to_cover.any_ofstringOptional
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.gtnumberOptional
Search days_to_cover for values that are greater than the given value.
days_to_cover.gtenumberOptional
Search days_to_cover for values that are greater than or equal to the given value.
days_to_cover.ltnumberOptional
Search days_to_cover for values that are less than the given value.
days_to_cover.ltenumberOptional
Search days_to_cover for values that are less than or equal to the given value.
settlement_datestringOptional
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_ofstringOptional
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
settlement_date.gtstringOptional
Search settlement_date for values that are greater than the given value.
settlement_date.gtestringOptional
Search settlement_date for values that are greater than or equal to the given value.
settlement_date.ltstringOptional
Search settlement_date for values that are less than the given value.
settlement_date.ltestringOptional
Search settlement_date for values that are less than or equal to the given value.
avg_daily_volumeintegerOptional
The average daily trading volume for the stock over a specified period, typically used to contextualize short interest.
avg_daily_volume.any_ofstringOptional
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.gtintegerOptional
Search avg_daily_volume for values that are greater than the given value.
avg_daily_volume.gteintegerOptional
Search avg_daily_volume for values that are greater than or equal to the given value.
avg_daily_volume.ltintegerOptional
Search avg_daily_volume for values that are less than the given value.
avg_daily_volume.lteintegerOptional
Search avg_daily_volume for values that are less than or equal to the given value.
limitintegerOptional
Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'.
sortstringOptional
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.
apiKeystringRequired
API key for authentication.
