POST/shorts.v1alpha1.OwnershipService/GetInstitution

GetInstitution

One institution: its current substantial holdings, its notices, its funds and what its holdings files hold.

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

slugstring

(proto string)

Responses

200Success

application/json

object

fundHoldingsarray

The largest holdings, by value, of its latest holdings files. (proto shorts.v1alpha1.FundHolding)

Array Items:

object

One stock in one fund's holdings file.

fundsarray

(proto shorts.v1alpha1.OwnershipFund)

Array Items:

object

A product in the fund registers.

institutionobject

(proto shorts.v1alpha1.OwnershipInstitution)

aumAsAtstring

(proto string)

aumAudnumber <double>

A super fund's total assets: the sum of the APRA-regulated funds it is trustee of (APRA's annual fund-level statistics). (proto double)

countrystring

(proto string)

descriptionstring

(proto string)

fundsinteger <int32>

Products linked to it in the fund registers (ETFs, LICs, super funds), with their combined size (FUM, market cap or total assets). (proto int32)

fundsSizeAudnumber <double>

(proto double)

hasAumboolean

(proto bool)

hasFundsSizeboolean

(proto bool)

kindstring

super_fund, index_manager, hedge_fund, active_manager, bank_broker, sovereign_public, insurer, private_equity, corporate, other. (proto string)

latestNoticeDatestring

(proto string)

namestring

(proto string)

noticesinteger <int32>

(proto int32)

slugstring

(proto string)

substantialPositionsinteger <int32>

Current substantial holdings and the notices behind them. (proto int32)

websitestring

(proto string)

noticesarray

(proto shorts.v1alpha1.SubstantialNotice)

Array Items:

object

One notice as released.

positionsarray

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

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/GetInstitution" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string"
}'

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