Skip to main content
POST
Short Interest History

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
SingleIdentifier · object
required

The company, by RavenPack entity id.

from_date
string<date>
required

First day of the window, as YYYY-MM-DD.

Example:

"2026-01-02"

to_date
string<date> | null

Last day of the window, as YYYY-MM-DD. Defaults to today, so the window ends on the last day with data.

Example:

"2026-06-30"

metrics
enum<string>[] | null

Which metrics the rows carry; every metric when left out. short_interest fills shares_short, shares_short_value_usd and percent_of_free_float; cost_to_borrow fills cost_to_borrow and cost_to_borrow_new_loans; shares_available_to_borrow fills shares_available_to_borrow and shares_available_to_borrow_count; the others fill the field of the same name.

Minimum array length: 1

A group of figures the series can carry.

Available options:
short_interest,
days_to_cover,
cost_to_borrow,
shares_available_to_borrow,
short_score
Example:
days_to_cover_period
enum<string>
default:3M

The trailing window whose average daily volume days to cover divides by.

Available options:
1W,
2W,
1M,
3M
limit
integer
default:250

Trading days per page, from 1 to 1000. A year is about 252.

Required range: 1 <= x <= 1000
Example:

250

cursor
string | null

Token for the next page. Send back pagination.cursor from the previous response, unchanged and with the same identifier, window, metrics and days_to_cover_period; limit may differ. Omit it for the first page.

Maximum string length: 1024

Response

Successful Response

results
ShortInterestDay · object[]
required

One row per trading day with data in the page, oldest first. A response holds one page; send pagination.cursor back as cursor for the next.

metadata
ShortInterestHistoryMetadata · object
required
errors
ErrorDetail · object[] | null
pagination
Pagination · object | null

Common pagination response for endpoints that support pagination.

sources
Source · object[] | null

Structured-data sources the response was built from, one entry per source. Empty when no catalog source contributed.

usage
Usage · object | null

Tokens the request consumed, per content tier. Returned only to callers billed in tokens.