POST/shorts.v1alpha1.MarketService/GetShortCampaignScoreboard

GetShortCampaignScoreboard

Get the short-seller scoreboard: historic short campaigns and whether shorts won

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 GetShortCampaignScoreboard RPC

industrystring

optional exact industry filter (proto string)

limitinteger <int32>

(proto int32)

offsetinteger <int32>

(proto int32)

Responses

200Success

application/json

object

Response for GetShortCampaignScoreboard RPC

campaignsarray

(proto shorts.v1alpha1.ShortCampaign)

Array Items:

object

A historic short campaign: the peak short position and what the price did after

campaignsTotalinteger <int32>

campaigns considered for the win-rate stats (proto int32)

shortsWinRate3mnumber <double>

percent (0-100) of scored campaigns where the price fell after 3 months (proto double)

shortsWinRate6mnumber <double>

percent (0-100) of scored campaigns where the price fell after 6 months (proto double)

totalCountinteger <int32>

campaigns matching the filter (proto int32)

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/GetShortCampaignScoreboard" \
  -H "Content-Type: application/json" \
  -d '{
  "industry": "string",
  "limit": 0,
  "offset": 0
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.MarketService/GetShortCampaignScoreboard" \
  -H "Content-Type: application/json" \
  -d '{
  "industry": "string",
  "limit": 0,
  "offset": 0
}'