Skip to main content
POST
/
beta
/
investment
/
transactions
/
get
Get transactions
curl --request POST \
  --url https://app.standardmetrics.io/beta/investment/transactions/get/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_ids": [
    "pvYe",
    "a2Ne"
  ],
  "transaction_ids": [
    "pvYe",
    "a2Ne"
  ],
  "event": "sale",
  "input_security_id": "pvYe",
  "output_security_id": "a2Ne"
}
'
[
  {
    "id": "<string>",
    "company_id": "<string>",
    "company_name": "<string>",
    "input_security_id": "pvYe",
    "output_security_id": "pvYe",
    "date": "2023-12-25",
    "event": "exercise",
    "shares": "1000000",
    "investment_amount": {
      "value": "1000000",
      "currency": "USD",
      "converted_value": "1000000",
      "converted_currency": "USD",
      "fx_rate": "1.0",
      "is_custom_rate": false
    },
    "proceeds": {
      "currency": "USD",
      "value": "1000000"
    }
  }
]

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:
["pvYe", "a2Ne"]
​
transaction_ids
string[] | null

Filter by transaction IDs.

Example:
["pvYe", "a2Ne"]
​
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:
{ "currency": "USD", "value": "1000000" }
​
proceeds
MoneyAmount · object
required

The amount of money that was received from the transaction.

Example:
{ "currency": "USD", "value": "1000000" }