Shorted
POST/shorts.v1alpha1.ShortedStocksService/GetIndustryTreeMap

Get Industry TreeMap

Retrieve a hierarchical treemap of short positions grouped by industry. Useful for visualizing market-wide shorting trends.

Parameters

Request Body

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

Responses

200A successful response containing industry-grouped short position data.
application/json
object
industriesarray
Array Items:
string
stocksarray
Array Items:
400Invalid request parameters.
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/GetIndustryTreeMap" \
  -H "Content-Type: application/json" \
  -d '{
  "period": "3m",
  "limit": 10,
  "viewMode": "CURRENT_CHANGE"
}'