Skip to main content
POST
/
beta
/
investment
/
share-classes
/
get
Get share classes
curl --request POST \
  --url https://app.standardmetrics.io/beta/investment/share-classes/get/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_ids": [
    "<string>"
  ]
}
'
[
  {
    "company_id": "<string>",
    "financing_id": "<string>",
    "purchase_type": "primary",
    "type": "common",
    "name": "<string>",
    "price_per_share": {
      "value": "1000000",
      "currency": "USD",
      "converted_value": "1000000",
      "preferred_currency": "USD",
      "fx_rate": "1.0",
      "is_custom_rate": false
    },
    "id": "a2Ne",
    "include_in_fair_value": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
  • CompanyIDFilter
  • ShareClassIDFilter

Options for fetching share classes.

​
company_ids
string[]
required

Response

200 - application/json

OK

​
company_id
string
required
​
financing_id
string
required
​
purchase_type
enum<string>
required
Available options:
primary,
secondary
​
type
enum<string>
required
Available options:
common,
preferred
​
name
string
required
​
price_per_share
MoneyAmount · object
required

A monetary amount.

​
id
string | null

The ID of the share class. Output only.

Example:

"a2Ne"

​
include_in_fair_value
boolean | null

Whether the share class is included in the fair value calculation. Defaults to True when the purchase_type is primary, otherwise False.

Example:

true