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": [
    "<string>"
  ]
}'
[
  {
    "id": "a2Ne",
    "company_id": "pvYe",
    "input_security_id": "pvYe",
    "output_security_id": "pvYe",
    "date": "2020-01-01",
    "event": "Sale",
    "shares": "1000000",
    "investment_amount": {
      "currency": "USD",
      "value": "1000000"
    },
    "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
  • CompanyIDFilter
  • TransactionIDFilter

Options for fetching transactions. Filter by company IDs.

​
company_ids
string[]
required

Response

200 - application/json

OK

​
id
string
required
Examples:

"a2Ne"

​
company_id
string
required
Examples:

"pvYe"

​
input_security_id
string | null
required

The ID for the security that was being transacted.

Examples:

"pvYe"

​
output_security_id
string | null
required

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

Examples:

"pvYe"

​
date
string<date>
required

The date of the transaction.

Examples:

"2020-01-01"

​
event
enum<string>
required

The type of transaction that occurred.

Available options:
exercise,
conversion,
sale
​
shares
required

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

Examples:

"1000000"

​
investment_amount
object
required

The amount of money that was invested in the transaction.

​
proceeds
object | null
required

The amount of money that was received from the transaction. A monetary amount.

Examples:
{ "currency": "USD", "value": "1000000" }
⌘I