latestOpenAPI 3.0.32026-08-101461131.1 MB

ad6f143e43aa

reference

Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms.

get/stocks/v1/short-volume

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.

datestring

The date of trade activity reported in the format YYYY-MM-DD

date.any_ofstring

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

date.gtstring

Filter greater than the value.

date.gtestring

Filter greater than or equal to the value.

date.ltstring

Filter less than the value.

date.ltestring

Filter less than or equal to the value.

short_volume_rationumber double

The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number.

short_volume_ratio.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.

short_volume_ratio.gtnumber double

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

short_volume_ratio.gtenumber double

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

short_volume_ratio.ltnumber double

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

short_volume_ratio.ltenumber double

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

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.