Skip to main content
POST
Get transactions

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

company_ids
string[] | null

Filter by company IDs.

Example:
transaction_ids
string[] | null

Filter by transaction IDs.

Example:
event
enum<string> | null

Filter by transaction event type.

Available options:
exercise,
conversion,
sale
Example:

"sale"

input_security_id
string | null

Filter by the input security ID of the transaction.

Example:

"pvYe"

output_security_id
string | null

Filter by the output security ID of the transaction.

Example:

"a2Ne"

Response

200 - application/json

OK

id
string
required

The ID of the transaction.

Example:

"a2Ne"

company_id
string
required

The ID of the company related to the transaction.

Example:

"pvYe"

company_name
string
required

The name of the company related to the record.

Example:

"Acme Corp"

input_security_id
string | null
required

The ID for the security that was being transacted.

Example:

"pvYe"

output_security_id
string | null
required

The ID for the security that was created as a result of the transaction.

Example:

"pvYe"

date
string<date>
required

The date of the transaction.

Example:

"2030-01-01"

event
enum<string>
required

The type of transaction that occurred.

Available options:
exercise,
conversion,
sale
Example:

"Sale"

shares
required

The number of shares that were transferred or sold as a result of the transaction.

Example:

"1000000"

investment_amount
MoneyAmount · object
required

The amount of money that was invested in the transaction.

Example:
proceeds
MoneyAmount · object | null
required

The amount of money that was received from the transaction.

Example: