Short Interest
GET/v1/quote/{symbol}/short-selling/short-interestGet 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
| Name | Type | In | Required | Description |
|---|---|---|---|---|
symbol | string | path | yes | Symbol code, e.g. HK.00700 or US.AAPL. |
count | int | query | no | Number of records. Default 30, max 90. |
Request Example
bash
curl "$ip/v1/quote/HK.00700/short-selling/short-interest?count=2" | jqResponse Fields
HK items fields:
| Field | Type | Description |
|---|---|---|
timestamp | int | Data time (millisecond timestamp). |
timestamp_str | string | Data date (yyyy-MM-dd). |
aggregated_short | string | Outstanding short shares (int64 serialized as string). |
aggregated_short_ratio | float | Percentage of float (%). |
close_price | float | Close price on the day. |
last_close_price | float | Previous trading day close price. |
avg_cost | float | Average short position cost. |
avg_daily_short_volume | string | Average daily short volume. |
US items fields:
| Field | Type | Description |
|---|---|---|
timestamp | int | Data time (millisecond timestamp). |
timestamp_str | string | Data date (yyyy-MM-dd). |
shares_short | string | Short shares (int64 serialized as string). |
short_percent | float | Short percentage (%). |
avg_daily_share_volume | string | Average daily share volume. |
days_to_cover | float | Days to cover. |
close_price | float | Close price. |
last_close_price | float | Previous trading day close price. |
avg_daily_short_volume | string | Average 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_code | error.code | Trigger Condition | Handling |
|---|---|---|---|
| 0 | -- | Success | -- |
| -3 | invalid_parameter | count out of range / invalid symbol format | Correct parameters and retry |
| -7 | invalid_symbol | Symbol format is valid but security does not exist | Verify symbol code |
| -8 | unsupported | Market or category not in supported range | Only call for HK/US stocks and funds |
| -10 | no_data | No short interest data for the security | Treat as no short data available |
| -5 | internal_error | Gateway or backend internal error | Retry; 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"
}
]
}
}