Short Flow
Query daily short-sale volume and ratios.
Available data
- Returns
- Daily short volume, total volume and short ratio
- Market coverage
- US and HK stocks
- What each request returns
- View daily short-sale volume for a stock or ETF.
Authentication
Query Parameters
Provide at least one of asset_id or query. query also requires market
asset_idstringqueryconditionalAsset identifier for stocks, crypto assets and other asset objects
querystringqueryconditionalStock or ETF ticker/name; market is required when using query
Required with query; optional with asset_id
marketstringqueryconditionalRequired with query; optional when asset_id identifies the subject. US and HK stocks
Filter daily short-sale volume by stock or ETF and trading date
asset_classstringqueryoptionalAsset class for disambiguation; cannot override the endpoint subject type
sourcestringqueryoptionalData routing; defaults to auto. Available routes depend on market and asset class
include_venue_breakdownbooleanqueryoptionalWhether to return reporting institution details
fromdatequeryoptionalInclusive start date: reporting date for institutional rows, trade date for other lists
todatequeryoptionalInclusive end date; must not precede from
pageintegerqueryoptionalPage number, starting at 1; defaults to 1
page_sizeintegerqueryoptionalDefaults to 50, maximum 100; explicitly set 20 if preferred
Response
request_idstringExamplereq_exampleRequest trace ID
Object resolution status
Data status
Business data
Business records
trade_datedateExample2026-10-28Trade date
short_volumenumberExample5519973Daily short-sale volume
short_exempt_volumenumber | nullShort-exempt volume
total_volumenumberExample11897936Total volume within the same coverage
short_rationumberExample0.46394375Short volume as a share of total volume, 0–1
short_turnovernumber | nullShort-sale turnover
currencystring | nullAmount currency; HKD southbound, CNY northbound
listing_idstringExamplelisting_aapl_xnasListing ID
tickerstringExampleAAPLSecurity ticker
source_symbolstringExampleAAPLSource security code
Pagination, freshness and limitations
GateData object references
Object type
idstringExampleasset_aapl_common_stockObject ID
Pagination
pageintegerExample1Current page
page_sizeintegerExample20Page size
totalintegerExample1Total matching records
Source tracking array
ref_idstringExamplesrc_opaqueSource tracking ID
observed_atdatetimeExample2026-10-30T05:00:00ZData observation time
updated_atdatetimeExample2026-10-30T05:00:00ZData update time (UTC)
limitations[]string[]Examplecoverage_limitationAdditional information
errorobject | nullError object; null on success