docs
Short Interest API

Short Interest API

The Short Interest API allows you to retrieve short interest data with various filtering, sorting, pagination, and projection options.

Endpoint

GET /api/short-interest

Query Parameters

The following query parameters are available for customizing the results:

averageDailyVolumeQuantity (Number): Filters the results based on the average daily volume quantity. changePercent (Number): Filters the results based on the change percent. changePreviousNumber (Number): Filters the results based on the change previous number. currentShortPositionQuantity (Number): Filters the results based on the current short position quantity. daysToCoverQuantity (Number): Filters the results based on the days to cover quantity. marketClassCode (String): Filters the results based on the market class code. previousShortPositionQuantity (Number): Filters the results based on the previous short position quantity. settlementDate (String): Filters the results based on the settlement date. symbolCode (String): Filters the results based on the symbol code. page.size (Number): Specifies the number of results per page.

Supported Operators

The filtering parameters support the following operators:

  • = Equal to
  • != Not equal to
  • > Greater than
  • < Less than
  • >= Greater than or equal to
  • <= Less than or equal to
  • is Check if value is a specific value
  • in Check if value is in a list of values
  • like Perform a case-sensitive pattern match
  • ilike Perform a case-insensitive pattern match
  • contains Check if value contains a substring
  • containedBy Check if value is contained by a range
  • rangeGt Check if value is greater than a range
  • rangeGte Check if value is greater than or equal to a range
  • rangeLt Check if value is less than a range
  • rangeLte Check if value is less than or equal to a range
  • rangeAdjacent Check if value is adjacent to a range
  • overlaps Check if value overlaps with a range
  • or Perform logical OR on multiple conditions

Request Examples

Example 1: Filter by Symbol Code and Average Daily Volume Quantity

GET /api/short-interest?filter:symbolCode=ABC&filter:averageDailyVolumeQuantity>100000 This example retrieves short interest data where the symbol code is "ABC" and the average daily volume quantity is greater than 100,000.

Example 2: Sort by Change Percent and Paginate

GET /api/short-interest?sort=changePercent&page.size=20&page.number=2 This example retrieves short interest data, sorts the results by change percent, and returns 20 results per page, starting from page number 2.

Response

The response will include the short interest data based on the provided query parameters.

Please note that the response format and data structure will depend on the specific implementation and database used.

Validation

The following validation rules apply to the query parameters:

averageDailyVolumeQuantity: Must be a positive number. changePercent: Must be a number. changePreviousNumber: Must be a number. currentShortPositionQuantity: Must be a positive number. daysToCoverQuantity: Must be a positive number. marketClassCode: Must be a string with a maximum length of 20 characters. previousShortPositionQuantity: Must be a positive number. settlementDate: Must be a string. symbolCode: Must be a string with a maximum length of 20 characters. page.size: Must be a number between 0 and 10000.

IntroductionGlossary