Skip to main content
GET
/
v1
/
financials
/
short-volume
Get Short Volume Data
curl --request GET \
  --url https://api.aries.com/v1/financials/short-volume \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "ticker": "AAPL",
      "date": "2024-02-06",
      "shortVolume": 5683713,
      "shortVolumeRatio": 34.95,
      "totalVolume": 16264662,
      "exemptVolume": 67840,
      "nonExemptVolume": 5615873,
      "adfShortVolume": 0,
      "adfShortVolumeExempt": 0,
      "nasdaqCarteretShortVolume": 5298900,
      "nasdaqCarteretShortVolumeExempt": 63532,
      "nasdaqChicagoShortVolume": 28784,
      "nasdaqChicagoShortVolumeExempt": 0,
      "nyseShortVolume": 356029,
      "nyseShortVolumeExempt": 4308
    }
  ],
  "status": "OK",
  "requestId": "c701bead81e94e7186f6042474b117d8",
  "nextUrl": "https://api.aries.com/v1/financials/short-volume?cursor=..."
}

Documentation Index

Fetch the complete documentation index at: https://finance.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.

Query Parameters

​
tickers
string

Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company.

Example:

"AAPL"

​
tickersAnyOf
string

Comma-separated list of ticker symbols.

Example:

"AAPL,MSFT,GOOG"

​
tickerAfter
string

Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself.

​
tickerFrom
string

Ticker greater than or equal (inclusive)

​
tickerBefore
string

Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself.

​
tickerTo
string

Ticker less than or equal (inclusive)

​
date
string<date>

Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day.

​
dates
string

Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request.

​
dateAfter
string<date>

After-date filter. Returns records after this date, excluding the date itself.

​
dateFrom
string<date>

Start-date filter. Returns records on or after this date.

​
dateBefore
string<date>

Before-date filter. Returns records before this date, excluding the date itself.

​
dateTo
string<date>

End-date filter. Returns records on or before this date.

​
shortVolumeRatio
number<double>

Exact short-volume ratio filter. Use it when you need records matching one specific ratio value.

​
shortVolumeRatioList
string

Comma-separated list of short volume ratios

​
shortVolumeRatioAbove
number<double>

Short volume ratio greater than (exclusive)

​
shortVolumeRatioMin
number<double>

Short volume ratio greater than or equal (inclusive)

​
shortVolumeRatioBelow
number<double>

Short volume ratio less than (exclusive)

​
shortVolumeRatioMax
number<double>

Short volume ratio less than or equal (inclusive)

​
totalVolume
integer<int64>

Exact total-volume filter. Use it when you need records matching one specific volume value.

​
totalVolumeList
string

Comma-separated list of total volumes

​
totalVolumeAbove
integer<int64>

Total volume greater than (exclusive)

​
totalVolumeMin
integer<int64>

Total volume greater than or equal (inclusive)

​
totalVolumeBelow
integer<int64>

Total-volume upper-bound filter. Returns records below this value, excluding the value itself.

​
totalVolumeMax
integer<int64>

Total volume less than or equal (inclusive)

​
limit
integer

Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits.

Required range: x >= 1
​
sort
string

Field used to sort results. Enter one of the sort fields supported by this endpoint.

​
next
string

Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page.

Response

Successful response

​
results
object[]
​
status
string
​
requestId
string
​
nextUrl
string