Shorted
POST/shorts.v1alpha1.StockService/GetStockFundamentals

GetStockFundamentals

Per-period reported fundamentals (revenue, net income, EPS, cash flow, shares) and year-on-year growth for a stock. Every value carries a has_* flag: a missing figure is absent, never zero.

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

limitinteger <int32>

Max periods, newest first (default 12, max 40). (proto int32)

periodTypestring

Optional: "annual" | "half" | "quarter" | "ttm". Empty returns every type. (proto string)

stockCodestring

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

Responses

200Success
application/json
object

Response for GetStockFundamentals.

growthobject

(proto shorts.v1alpha1.FundamentalsGrowth)

basisPeriodTypestring

Series the EPS growth was computed on: "half", "ttm" or "annual". (proto string)

epsHalfYoyPctnumber <double>

(proto double)

epsTtmnumber <double>

(proto double)

epsYoyPctnumber <double>

(proto double)

epsYoyPriorPctnumber <double>

(proto double)

halfLatestPeriodEndstring

YYYY-MM-DD of the latest half-year row; empty when none. (proto string)

hasEpsHalfYoyboolean

(proto bool)

hasEpsTtmboolean

(proto bool)

hasEpsYoyboolean

(proto bool)

hasEpsYoyPriorboolean

(proto bool)

hasNetIncomeTtmboolean

(proto bool)

hasRevenueHalfYoyboolean

(proto bool)

hasRevenueTtmboolean

(proto bool)

hasRevenueYoyboolean

(proto bool)

hasRevenueYoyPriorboolean

(proto bool)

latestPeriodEndstring

YYYY-MM-DD of the latest period in that series. (proto string)

netIncomePositiveboolean

Latest annual net income above zero. (proto bool)

netIncomeTtmnumber <double>

(proto double)

periodsAvailableinteger <int32>

(proto int32)

revenueBasisPeriodTypestring

Series the revenue growth was computed on: "half" (latest half-year from a company filing vs the same half a year earlier, used when it is newer than the latest annual) or "annual". Empty when unknown. (proto string)

revenueHalfYoyPctnumber <double>

Latest half-year vs the same half a year earlier, from company filings, whether or not the half is the chosen basis. (proto double)

revenueTtmnumber <double>

Latest trailing-twelve-month points. (proto double)

revenueYoyPctnumber <double>

Revenue growth on revenue_basis_period_type vs the same series a year earlier. (proto double)

revenueYoyPriorPctnumber <double>

The same growth one period earlier, for acceleration. (proto double)

hasGrowthboolean

False when no growth row exists yet. (proto bool)

periodsarray

Newest first. (proto shorts.v1alpha1.FundamentalsPeriod)

Array Items:
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:
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.StockService/GetStockFundamentals" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "periodType": "string",
  "stockCode": "string"
}'