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可选
Search ticker for values that are greater than the given value.
ticker.gtestring可选
Search ticker for values that are greater than or equal to the given value.
ticker.ltstring可选
Search ticker for values that are less than the given value.
ticker.ltestring可选
Search ticker for values that are less than or equal to the given value.
days_to_covernumber可选
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_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可选
Search days_to_cover for values that are greater than the given value.
days_to_cover.gtenumber可选
Search days_to_cover for values that are greater than or equal to the given value.
days_to_cover.ltnumber可选
Search days_to_cover for values that are less than the given value.
days_to_cover.ltenumber可选
Search days_to_cover for values that are less than or equal to the given value.
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可选
Search settlement_date for values that are greater than the given value.
settlement_date.gtestring可选
Search settlement_date for values that are greater than or equal to the given value.
settlement_date.ltstring可选
Search settlement_date for values that are less than the given value.
settlement_date.ltestring可选
Search settlement_date for values that are less than or equal to the given value.
avg_daily_volumeinteger可选
The average daily trading volume for the stock over a specified period, typically used to contextualize short interest.
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可选
Search avg_daily_volume for values that are greater than the given value.
avg_daily_volume.gteinteger可选
Search avg_daily_volume for values that are greater than or equal to the given value.
avg_daily_volume.ltinteger可选
Search avg_daily_volume for values that are less than the given value.
avg_daily_volume.lteinteger可选
Search avg_daily_volume for values that are less than or equal to the given value.
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.
apiKeystring必填
API key for authentication.
