Skip to main content
POST
Get securities

Authorizations

Authorization
string
header
required

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

Body

application/json

Options for fetching securities.

company_ids
string[] | null

Filter by company IDs.

Example:
security_ids
string[] | null

Filter by security IDs.

Example:
fund_id
string | null

Filter by fund ID.

Example:

"pvYe"

Response

200 - application/json

OK

A certificate being returned from our API.

issue_date
string<date>
required

The date the security was issued.

Example:

"2020-01-01"

fund_id
string
required

The ID of the fund that holds this security.

Example:

"a2Ne"

company_id
string
required

The ID of the company this security belongs to.

Example:

"pvYe"

fund_name
string
required

The name of the fund that holds this security.

Example:

"Fund I"

company_name
string
required

The name of the company this security belongs to.

Example:

"Acme Corp"

investment_amount
MoneyAmount · object
required

The total investment amount for this certificate.

Example:
shares
required

The number of shares held.

Example:

"50000"

share_class_id
string
required

The ID of the share class for this certificate.

Example:

"a2Ne"

financing_id
string | null
required

The ID of the financing round this certificate belongs to.

Example:

"a2Ne"

share_class_name
string
required

The name of the share class for this certificate.

Example:

"Series A"

id
string | null

The ID of the security.

Example:

"a2Ne"

type
string
default:certificate
Allowed value: "certificate"