POST/shorts.v1alpha1.ShortedStocksService/GetStockData

Get Stock Time Series Data

Retrieve historical short position data for a specific stock over a defined time period. Requires authentication.

Parameters

Request Body

application/json

object

productCodestring*

periodstring [1m, 3m, 6m, 1y, 2y, max]default: "3m"

Responses

200A successful response containing historical time series points.

application/json

object

productCodestring

namestring

latestShortPositionnumber

pointsarray

Array Items:

object

maxobject

timestampstring <date-time>

shortPositionnumber

minobject

timestampstring <date-time>

shortPositionnumber

401Authentication is required to access private time series data.

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/GetStockData" \
  -H "Content-Type: application/json" \
  -d '{
  "productCode": "CBA",
  "period": "3m"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.ShortedStocksService/GetStockData" \
  -H "Content-Type: application/json" \
  -d '{
  "productCode": "CBA",
  "period": "3m"
}'