List Security Transactions

URL Expired

The URL for this request expired after 30 days.

Portfolio & Security Transactions

Parameters

• portfolioId
  string
  required
  The portfolio id of the portfolio for which security transactions are to be retrieved.

• issuerId
  string
  required
  The identifier of the issuer for which security transactions are to be retrieved.

• pageSize
  int32
  The maximum number of security transactions to return. The service may return fewer than this value. If unspecified, at most 50 security transactions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

• pageToken
  string
  A URL-encoded page token received as nextPageToken in a previous List Security Transactions response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to securityTransactions must match the call that provided the page token.

Response

Success Response

200      A successful response.

• securitytransactions
  array of objects
  The retrieved security transactions.

• securitytransactions
  object
  Information about the portfolio security transaction.

• portfolioId
  string
  length between 1 and 50
  The identifier of the portfolio which holds the security.

• portfolioName
  string
  length ≤ 1000
  The name of the portfolio which holds the security.

• issuerId
  string
  length between 1 and 50
  The identifier of the issuing corporation.

• issuerName
  string
  length ≤ 1000
  The legal name of the issuing corporation.

• transactionTime
  date-time
  The time of the transaction.

• transactionType
  string
  enum
  The type of transaction.

• transactionStatus
  string
  enum
  The status of the transaction.

• securityType
  string
  enum
  The type of security related to the transaction.

• optionGrantTransactionDetail
  object
  Information about the portfolio option grant transaction

• shareTransactionDetail
  object
  Information about the portfolio share transaction.

• rsuTransactionDetail
  object
  Information about the portfolio RSU transaction.

• nextPageToken
  string
  Submit the URL-encoded nextPageToken string as pageToken in a subsequent request to retrieve the next page. If the List Security Transactions response omits nextPageToken, then there are no subsequent pages.

Error Responses

• 400
  Returned if required fields are omitted or if provided fields fail validation.

• 401
  Returned if a valid Authorization header has not been included with the request.

• 403
  Returned when the user does not have permission to access the resource.

• 500
  Returned if an unexpected internal server error is encountered.

• default
  An unexpected error response.

Example Request

curl --request GET \
     --url https://mock-api.carta.com/v1alpha1/portfolios/portfolioId/issuers/issuerId/securityTransactions \
     --header 'accept: application/json'

Example Response

{
  "securitytransactions": [
    {
      "portfolioId": "174",
      "portfolioName": "Tagg Palmer's Portfolio",
      "issuerId": "7",
      "issuerName": "Meetly",
      "transactionTime": "2022-05-00:00:01.611Z",
      "transactionType": "TRANSACTION_TYPE_OPTION_GRANT_EXERCISE",
      "transactionStatus": "TRANSACTION_STATUS_COMPLETED",
      "securityType": "SECURITY_TYPE_SHARE",
      "shareTransactionDetail": {
        "securityId": "13087",
        "securityLabel": "CS-41",
        "shareClass": "Common",
        "saleQuantity": {
          "value": "3.00"
        },
        "issuanceFairMarketValue": {
          "currencyCode": {
            "value": "USD"
          },
          "amount": {
            "value": "8.12"
          }
        },
        "saleFairMarketValue": {
          "currencyCode": {
            "value": "USD"
          },
          "amount": {
            "value": "8.12"
          }
        },
        "salePrice": {
          "currencyCode": {
            "value": "USD"
          },
          "amount": {
            "value": "30.00"
          }
        },
        "costBasis": {
          "currencyCode": {
            "value": "USD"
          },
          "amount": {
            "value": "3.00"
          }
        },
        "adjustedCostBasis": {
          "currencyCode": {
            "value": "USD"
          },
          "amount": {
            "value": "24.36"
          }
        }
      }
    }
  ],
  "nextPageToken": "EXERCISE#Mzg3"
}