POST/shorts.v1alpha1.MarketService/GetTopShorts

GetTopShorts

Shows top 10 short positions on the ASX over different periods of time.

Parameters

Connect-Protocol-VersionheaderRequired

number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader

number

Define the timeout, in ms

Request Body

application/json

object

Request for Top10 RPC, specifying the period of time.

limitinteger <int32>

(proto int32)

offsetinteger <int32>

(proto int32)

periodstring

(proto string)

productCodesarray

Optional explicit set of product codes to return time series for, INSTEAD of the top-`limit` ranking. Lets callers that already know which stocks they need (e.g. industry-crowding constituents) fetch just those series rather than every top-N stock's points. Ignored when empty. When set with summary_only=false, `limit`/`offset` are not applied to the code set. (proto string)

Array Items:

string

summaryOnlyboolean

When true, returns only product code, name, and latest short position without time series points. Much faster and smaller response. (proto bool)

Responses

200Success

application/json

object

Response for Top10 RPC, including time series data for each of the top 10 short positions.

offsetinteger <int32>

(proto int32)

timeSeriesarray

(proto stocks.v1alpha1.TimeSeriesData)

Array Items:

object

TimeSeriesData represents time series data for a stock.

defaultError

application/json

object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:

object

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.MarketService/GetTopShorts" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "offset": 0,
  "period": "string",
  "productCodes": [
    "string"
  ],
  "summaryOnly": true
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.MarketService/GetTopShorts" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "offset": 0,
  "period": "string",
  "productCodes": [
    "string"
  ],
  "summaryOnly": true
}'