Shorted
POST/shorts.v1alpha1.ShortedStocksService/GetTopShorts

Get Top Shorts

Retrieve the top shorted stocks on the ASX for a given time period. Supports pagination and custom limits.

Parameters

Request Body

application/json
object
periodstring [1m, 3m, 6m, 1y, 2y, max]default: "3m"
limitintegerdefault: 10
offsetintegerdefault: 0

Responses

200A successful response containing time series data for the top shorted stocks.
application/json
object
timeSeriesarray
Array Items:
offsetinteger
400Invalid request parameters provided.
application/json
object
codestring [CodeCanceled, CodeUnknown, CodeInvalidArgument, CodeDeadlineExceeded, CodeNotFound, CodeAlreadyExists, CodePermissionDenied, CodeResourceExhausted, CodeFailedPrecondition, CodeAborted, CodeOutOfRange, CodeInternal, CodeUnavailable, CodeDataLoss, CodeUnauthenticated]*
messagestring*
detailobject
curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.ShortedStocksService/GetTopShorts" \
  -H "Content-Type: application/json" \
  -d '{
  "period": "3m",
  "limit": 10,
  "offset": 0
}'