Short Interest

Short Interest Summary

Short interest grouped for charts and rankings: by sector, industry or country of the company, by short percent bucket, or total short interest per settlement date.

The answer is {group_by, settlement_date (not for group_by=date), total_groups, groups, totals, about}. Each group carries its name under the group_by key (sector, industry, country, bucket or date). Requires a full API key.

get/short-interest/summary

Request

  • Base URL: https://api.dataporium.io
  • URL: https://api.dataporium.io/short-interest/summary
  • Auth: API key in query parameter apikey

Query parameters

group_bystring required

sector, industry, country (of the company headquarters), bucket (short percent ranges) or date (settlement dates)

settlement_datestring

Settlement date (YYYY-MM-DD); default the newest. Not used with group_by=date

marketstring

nyse, nasdaq, nyse_american, otc or listed (default listed), as in the ranking

sectorstring

Company sector(s), comma-separated

industrystring

Company industry(ies), comma-separated

countrystring

Country(ies) of the company headquarters, comma-separated

stocks_onlyboolean

true (default) = only stocks

min_market_capnumber

Smallest market cap in US dollars (not used with group_by=date)

companystring

Company search: the start of a ticker or part of a company name

symbolstring

One ticker; with group_by=date it gives the history of that ticker

sortstring

short_value (default), short_interest, stocks, avg_short_pct, weighted_short_pct, market_cap or key

orderstring

asc or desc (default desc; asc for key)

limitinteger

Groups per page, 1 to 500 (default 30); with group_by=date, the number of settlement dates

Response

Successful response (JSON).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.