Skip to content

Short Interest

GET /v1/quote/{symbol}/short-selling/short-interest

Get short interest data for a stock (HK / US). Data is returned sorted by trading day from newest to oldest. HK returns short position details (outstanding short shares, percentage of float). US returns monthly short reports (short shares, short ratio, days to cover).

Parameters

NameTypeInRequiredDescription
symbolstringpathyesSymbol code, e.g. HK.00700 or US.AAPL.
countintquerynoNumber of records. Default 30, max 90.

Request Example

bash
curl "$ip/v1/quote/HK.00700/short-selling/short-interest?count=2" | jq

Response Fields

HK items fields:

FieldTypeDescription
timestampintData time (millisecond timestamp).
timestamp_strstringData date (yyyy-MM-dd).
aggregated_shortstringOutstanding short shares (int64 serialized as string).
aggregated_short_ratiofloatPercentage of float (%).
close_pricefloatClose price on the day.
last_close_pricefloatPrevious trading day close price.
avg_costfloatAverage short position cost.
avg_daily_short_volumestringAverage daily short volume.

US items fields:

FieldTypeDescription
timestampintData time (millisecond timestamp).
timestamp_strstringData date (yyyy-MM-dd).
shares_shortstringShort shares (int64 serialized as string).
short_percentfloatShort percentage (%).
avg_daily_share_volumestringAverage daily share volume.
days_to_coverfloatDays to cover.
close_pricefloatClose price.
last_close_pricefloatPrevious trading day close price.
avg_daily_short_volumestringAverage daily short volume.

Supported Markets

  • Markets: HK and US only.
  • Categories: Only stocks and funds (ETFs); indices, warrants, options are not supported.
  • Unsupported markets or categories return an unsupported error.

Error Codes

ret_codeerror.codeTrigger ConditionHandling
0--Success--
-3invalid_parametercount out of range / invalid symbol formatCorrect parameters and retry
-7invalid_symbolSymbol format is valid but security does not existVerify symbol code
-8unsupportedMarket or category not in supported rangeOnly call for HK/US stocks and funds
-10no_dataNo short interest data for the securityTreat as no short data available
-5internal_errorGateway or backend internal errorRetry; contact support if persistent

Response Example

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "items": [
      {
        "aggregated_short": "54177721",
        "aggregated_short_ratio": 0.59,
        "avg_cost": 456.399,
        "avg_daily_short_volume": "3755740",
        "close_price": 456.4,
        "last_close_price": 454.9,
        "timestamp": 1778774400000,
        "timestamp_str": "2026-05-15"
      },
      {
        "aggregated_short": "44972868",
        "aggregated_short_ratio": 0.49,
        "avg_cost": 471.399,
        "avg_daily_short_volume": "2392820",
        "close_price": 466.1,
        "last_close_price": 472.1,
        "timestamp": 1778169600000,
        "timestamp_str": "2026-05-08"
      }
    ]
  }
}