POST/shorts.v1alpha1.OwnershipService/GetStockOwnership

GetStockOwnership

Who holds one stock: its substantial holders, their notices, and the index ETFs and super fund options that hold it.

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

stockCodestring

(proto string)

Responses

200Success

application/json

object

fundHoldingsarray

(proto shorts.v1alpha1.FundHolding)

Array Items:

object

One stock in one fund's holdings file.

hasSharesOnIssueboolean

(proto bool)

historyarray

(proto shorts.v1alpha1.SubstantialNotice)

Array Items:

object

One notice as released.

holdersarray

(proto shorts.v1alpha1.SubstantialHolding)

Array Items:

object

A holder's current substantial holding in one stock: its latest notice, when that notice leaves it substantial.

sharesOnIssuenumber <double>

(proto double)

summaryobject

(proto shorts.v1alpha1.OwnershipStock)

byKindarray

(proto shorts.v1alpha1.KindShare)

companyNamestring

(proto string)

disclosedPctnumber <double>

(proto double)

hasIndexPctboolean

(proto bool)

hasMarketCapboolean

(proto bool)

hasShortPctboolean

(proto bool)

hasSuperValueboolean

(proto bool)

holdersinteger <int32>

Current substantial holders, and the sum of their voting power with each interest counted once: a group and its member (MUFG and First Sentier) count the larger figure, and two notices disclosing the same voting power as at the same date count once. Other overlaps remain, so the sum is what the notices disclose, not a share of the company. (proto int32)

indexPctnumber <double>

Shares held by the index ETFs tracked, over shares on issue. (proto double)

industrystring

(proto string)

marketCapnumber <double>

(proto double)

shortPctnumber <double>

ASIC's latest reported short position, as a percentage of shares on issue. (proto double)

stockCodestring

(proto string)

superOptionsinteger <int32>

Super fund options holding it, of those tracked, and their combined value. (proto int32)

superValueAudnumber <double>

(proto double)

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

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