POST/shorts.v1alpha1.StrategyService/GetStockStrategyFit

GetStockStrategyFit

How one stock reads against every strategy: status, score, rank and the per-rule pass / fail / unknown breakdown. A stock that is not a candidate for a strategy still gets its rule results, with status "none".

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 GetStockStrategyFit.

stockCodestring

ASX code, e.g. "BHP". (proto string)

Responses

200Success

application/json

object

Response for GetStockStrategyFit.

asOfstring

YYYY-MM-DD of the latest price in the universe. (proto string)

fitsarray

One per strategy; empty when the stock is outside the universe. (proto shorts.v1alpha1.StrategyFit)

Array Items:

object

One strategy's reading of one stock.

inUniverseboolean

(proto bool)

regimeobject

(proto shorts.v1alpha1.MarketRegime)

asOfstring

YYYY-MM-DD of the last index close. (proto string)

closenumber <double>

(proto double)

indexCodestring

(proto string)

pctOff52wHighnumber <double>

Negative or zero. (proto double)

regimestring

"uptrend" | "neutral" | "downtrend"; empty when unavailable. (proto string)

sma200number <double>

(proto double)

sma50number <double>

(proto double)

verdictstring

Strategy-specific sentence, e.g. "Stand aside: XJO below its 200-day average." (proto string)

stockCodestring

(proto string)

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.StrategyService/GetStockStrategyFit" \
  -H "Content-Type: application/json" \
  -d '{
  "stockCode": "string"
}'

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.StrategyService/GetStockStrategyFit" \
  -H "Content-Type: application/json" \
  -d '{
  "stockCode": "string"
}'